Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 980 Bytes

contributing.md

File metadata and controls

24 lines (18 loc) · 980 Bytes

Contributing

Connecting to the deployment platform

  • Run vercel link in the root folder and give credentials to login. This will be used to fetch env variables.

Setup on local

  • Fork this repository.
  • Run pnpm install in the root folder.
  • Intialize husky as specified here to make git hooks work in GUIs(eg GitHub Desktop)
  • Useful commands:
    • Run pnpm dev:env to pull env variables.
    • Run pnpm dev to start dev server for local development.
    • Run pnpm build for production build.
    • Run pnpm lint to lint all files.
    • Run pnpm e2e to run e2e of all workspaces.
    • Run pnpm test to run tests of all workspaces.

Guidelines for development

  • Install prettier and enable for this workplace, with default settings.
  • Follow pascalCase for this project.
  • Attach comments to complex logic, if required.