Skip to content

Commit

Permalink
chore: update the contributing guideline to include liveblocks stuff
Browse files Browse the repository at this point in the history
This step for going to Liveblocks to go get an API key and set stuff up was missing in the steps needed to set up the website locally, this commit adds it.
  • Loading branch information
tobySolutions authored Dec 1, 2023
1 parent 26c8bc8 commit d8b5c21
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,12 @@ The source code is divided into four main folders:

> Note: To contribute to the website, you need to have a basic understanding of [Next.js](https://nextjs.org/docs) and [MDX.](https://mdxjs.com/)
To run the website locally, you need to install the dependencies and run the development server:
To run the website locally:
- Go to [Liveblocks](https://liveblocks.io/) to create an account
- Get your API key and rename the `.env.example` to `.env`
- Add the API key to the `NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY`.

Then, you'll need to install the dependencies and run the development server following the commands below:

```bash
pnpm install
Expand Down

2 comments on commit d8b5c21

@vercel
Copy link

@vercel vercel bot commented on d8b5c21 Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

million-kitchen-sink – ./packages/kitchen-sink

million-kitchen-sink.vercel.app
million-kitchen-sink-git-main-millionjs.vercel.app
million-kitchen-sink-millionjs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on d8b5c21 Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sink – ./packages/kitchen-sink

sink-millionjs.vercel.app
sink.million.dev
sink-git-main-millionjs.vercel.app
million-kitchen-sink-atit.vercel.app

Please sign in to comment.