README.md

Set up

1. Setup Prettier on VScode and enable format on save for linting
2. Install Yarn (for PRs, avoid using npm to prevent conflicts with yarn.lock file)
3. Create .env file with DATABASE_URL, content can be found in Notion
4. Create a client_secret.json file in the root directory, content can be found in Notion
5. yarn
6. yarn dev to start the server

Database

Online Heroku Postgresql server

After modifying the database, run:

npx prisma generate

Fix Typescript error relating to prisma.ts

run yarn add -D @prisma/client

Dev commands

• yarn dev to start the server
• yarn build to check for build errors (should be done before pushing)
• npx eslint . --ext .ts,.tsx to check for linting errors
• npx eslint . --ext .ts,.tsx --fix to fix linting errors
• npx prisma show to show the database schema in a GUI
• npx prisma migrate dev --name <name> to create a new migration

Folder Structure

• /api vs /lib/server: /api is for server-side routes, handlers, serverless functions while /lib/server is for server-side libraries and utilities

Guidelines

• Follow Conventional Commits
• Files in the /pages folder generally should focus on the structure and layout of the page, try to avoid doing all of the logic in that single file. If it gets too messy or hard to read, create your corresponding folder in the /components folder and split up your components there. The more atomic the better.
• Magic strings and values should either be declared in the file as a constant, or in the /utils folder if it shared throughout. Examples of these are route strings, eg: const HOME_URL = "/home";
• Custom hooks should be in the /hooks folder directory.
• Pull requests should follow pull-request-template.md and tag the relevant GitHub issue under Development.