- Install
node.js20.nvmis a cross-platform Node.js manager, and you are recommended to use it install node.js if you have other projects using different node versions. Check https://nodejs.org/en/download for detailed instructions.
- clone the git project to your local
- inside the project folder, create a
.envfile, and add the required credentials and variables. You can find the credentials on clickup, or contact the team for help. - inside the project folder, run
npm installto install dependencies - run
npm run devto start the webapp, you should see the project running on yourlocalhost:3000
All changes should be added via Pull Requests and get reviewed before merging into the main branch. You must not directly push to the main branch.
Follow the steps below to add your change:
- create a working branch from the main branch
- work on your branch
- push your changes to your remote branch
- before creating a PR, you should run
npm run buildlocally to check if there is any issue in your change. Sometimes you can successfully run it in dev mode but fail the build. - create a PR to merge your working branch into main in GitHub
- resolve comments from other team members and merge conflicts (if any)
- after your PR passes the check and is approved, it is ready to merge. Usually the admin will merge it for you.