Collaborative Dashboard

Getting started

Run the following command to try this example locally:

$npx create-liveblocks-app@latest --example nextjs-dashboard --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

Alternatively, you can set up your project manually:

• Install all dependencies with npm install
• Create an account on liveblocks.io
• Copy your public key from the dashboard
• Create an .env.local file and add your public key as the NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY environment variable
• Run npm run dev and go to http://localhost:3000

Deploy on Vercel

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

$npx create-liveblocks-app@latest --example nextjs-dashboard --vercel

This will download the example and ask permission to open your browser, enabling you to deploy to Vercel. Next, you must:

• Create an account on liveblocks.io
• Copy your public key from the dashboard
• Add your public key as the NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY environment variable in the Vercel dashboard
• Run npm run start and open http://localhost:3000 in your browser