Prod application is hosted at https://andrew-bookfair.vercel.app/
Tests accounts:
- Admin: tpnguyen12+admin@myseneca.ca
- Users: tpnguyen12+user@myseneca.ca, tpnguyen12+user2@myseneca.ca
- Clone the repo
git clone https://github.com/Andrewnt219/bookfair.git- Checkout to dev branch
git checkout dev- Install pnpm (if you haven't)
npm i -g pnpm-
Download file and rename to
.env.localand move it into the root of your project. Get it here -
Download file and rename to
.envand move it into /functions. Get it here -
Install dependencies
pnpm install --frozen-lockfile
- Run the project.
pnpm dev:next- Website is lived at
http://localhost:3000.
On your local machine
- Create an issue for what you are working/fixing
- Create a new branch for the issue. Convention:
<YourName>/<IssueNumber>-<ShortBranchDescription>
git fetch origin
git checkout origin/dev
git switch -c "Andrew/19-CreateProfile- Update your local machine code
git pull origin dev --rebase
- Work on the issue, commit as you go
git commit -m "fix dog"
git commit -m "add cat"- Check if your branch has any conflicts
git pull origin dev --rebase
-
Fix conflicts if any
-
Push to remote repo
git push origin <your-branch-name> --set-upstream
- Code review
-
Create Pull Request
-
Make sure all checks are passed (Linters and TypeScript)
-
If any changes are required by reviewers, go back to your local machine. Go back to step 4 of the Contribution guide. If you recently solve conflicts, instead of
git push, usegit push --forcewith caution as this will overwrite your previous work -
Repeat step 3 until your Pull Request is approved.