README.md

Overlay Comments

This example shows how to display comments overlaid on any website with Liveblocks and Next.js.

Getting started

Run the following command to try this example locally:

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 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
• Copy your secret key from the dashboard
• 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

Deploy on Vercel

Read more

To both deploy on Vercel, and run the example locally, use the following command:

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 on CodeSandbox, create the LIVEBLOCKS_SECRET_KEY environment variable as a secret.