https://github.com/liveblocks/demo-comments-hover-boostr
https://github.com/liveblocks/demo-comments-hover-boostr
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/liveblocks/demo-comments-hover-boostr
- Owner: liveblocks
- Created: 2024-07-03T22:23:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T02:17:44.000Z (almost 2 years ago)
- Last Synced: 2025-01-13T21:13:18.823Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://demo-comments-hover-boostr.vercel.app
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overlay Comments
This example shows how to display comments overlaid on any website 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-comments-overlay --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-comments-overlay --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-comments-overlay)
on CodeSandbox, create the `LIVEBLOCKS_SECRET_KEY` environment variable as a
[secret](https://codesandbox.io/docs/secrets).