https://github.com/trace2798/ably_spaces_fullstack
Repo consisting of my Ably realtime experience hackathon 2023 submission
https://github.com/trace2798/ably_spaces_fullstack
ably ably-realtime nextjs
Last synced: 19 days ago
JSON representation
Repo consisting of my Ably realtime experience hackathon 2023 submission
- Host: GitHub
- URL: https://github.com/trace2798/ably_spaces_fullstack
- Owner: trace2798
- License: mit
- Created: 2023-10-12T14:00:13.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T10:09:54.000Z (over 2 years ago)
- Last Synced: 2025-01-22T06:48:07.901Z (over 1 year ago)
- Topics: ably, ably-realtime, nextjs
- Language: TypeScript
- Homepage: https://devpost.com/software/mosiac
- Size: 2.04 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mosiac made using Ably
### This repo is for my submission for the Ably Realtime Experiences Hackathon which took place during September 18 - November 01, 2023 PDT
## Getting Started
### Either fork the repo or directly clone it
### Prerequisites
**Node version 18.17 or later
**macOS, Windows (including WSL), and Linux are supported.
### To directly clone the repo
```shell
git clone https://github.com/trace2798/ably_spaces_fullstack.git
```
### Install packages
```shell
npm i
```
### Setup .env file
```ts
# Deployment used by `npx convex dev` Convex credentials
CONVEX_DEPLOYMENT=
NEXT_PUBLIC_CONVEX_URL=
# Auth Credentials
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
# Blog storage for images credentials
EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=
#ABLY key
NEXT_PUBLIC_ABLY_API_KEY=
```
### Resources for env values:
Check the official docs for the services mentioned.
### Start the app
```shell
npm run dev
```
## Available commands
Running commands with npm `npm run [command]`
| command | description |
| :------ | :--------------------------------------- |
| `dev` | Starts a development instance of the app |
| `build` | To build your application |
| `start` | Starts a production instance of the app |
Youtube Demo Link: [Mosiac](https://youtu.be/waSnSibWkJA)