Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sozonome committed Aug 7, 2024
1 parent 2dd9ce2 commit 56ba9c7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ my take on scrum poker, built using Next.js, Chakra-UI, and TypeScript.

https://user-images.githubusercontent.com/17046154/234649351-d48fba33-9a95-4256-ae0a-85f6d220abbc.mp4

## Pre-Requisites

- Node v20+ (recommended to install through `nvm`)
- This project uses pnpm as package manager (not yarn or npm). To install packages, run `pnpm i`
- It's recommended to install / use pnpm via [corepack](https://pnpm.io/installation#using-corepack)
- Make sure `.env.local` file is added (see / copy from `.env.example`)
- Firebase project

## Getting Started

First, run the development server:
Expand Down

0 comments on commit 56ba9c7

Please sign in to comment.