https://github.com/sudo-self/whiteboard
https://github.com/sudo-self/whiteboard
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/sudo-self/whiteboard
- Owner: sudo-self
- Created: 2024-02-25T21:14:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T21:14:14.000Z (over 2 years ago)
- Last Synced: 2025-01-24T14:46:41.297Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://whiteboard-sudo-self.vercel.app
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Collaborative Whiteboard (Advanced)
This example shows how to build an advanced collaborative whiteboard with [Liveblocks](https://liveblocks.io) and [Next.js](https://nextjs.org/).
## Getting started
Run the following command to try this example locally:
```bash
npx create-liveblocks-app@latest --example nextjs-whiteboard-advanced --api-key
```
This will download the example and ask permission to open your browser, enabling you to automatically get your API key from your [liveblocks.io](https://liveblocks.io) account.
### Manual setup
Read more
Alternatively, you can set up your project manually:
- Install all dependencies with `npm install`
- Create an account on [liveblocks.io](https://liveblocks.io/dashboard)
- Copy your **secret** key from the [dashboard](https://liveblocks.io/dashboard/apikeys)
- Create an `.env.local` file and add your **secret** key as the `LIVEBLOCKS_SECRET_KEY` environment variable
- Run `npm run dev` and go to [http://localhost:3000](http://localhost:3000)
### Deploy on Vercel
Read more
To both deploy on [Vercel](https://vercel.com), and run the example locally, use the following command:
```bash
npx create-liveblocks-app@latest --example nextjs-whiteboard-advanced --vercel
```
This will download the example and ask permission to open your browser, enabling you to deploy to Vercel.
### Develop on CodeSandbox
Read more
After forking [this example](https://codesandbox.io/s/github/liveblocks/liveblocks/tree/main/examples/nextjs-whiteboard-advanced) on CodeSandbox, create the `LIVEBLOCKS_SECRET_KEY` environment variable as a [secret](https://codesandbox.io/docs/secrets).