Contributing

First off, thanks for taking the time to contribute! 🙌

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Developing

Chirpy is built upon Next.js. To run this project locally, you'll need to install the following:

• nodejs@16+
• pnpm@7+

Fork and clone

Fork this repository to your own GitHub account and then clone it to your local device.

Set up the frontend only

If you only want to make UI changes, you can skip the back-end setup and do:

pnpm install
# Copy .env-template to .env.local and fill your own values
cp .env-template .env.local
# See your changes in Storybook
cd packages/ui
pnpm dev

Start the frontend app

# Generate required scripts
pnpm boostrap
# Start the main app
pnpm dev

Linting

pnpm lint

Building

Build the project locally, with:

pnpm build:local

Testing

# For unit tests
pnpm test
# For e2e tests
pnpm cy:open

Optional

Set up more environment variables

Tweak .env.local and fill variables as your needs, e.g. Email server secret, Google sign-in app id/key.