Skip to content

Andrewnt219/bookfair

Repository files navigation

Prod application is hosted at https://andrew-bookfair.vercel.app/

Tests accounts:

Development

  1. Clone the repo
git clone https://github.com/Andrewnt219/bookfair.git
  1. Checkout to dev branch
git checkout dev
  1. Install pnpm (if you haven't)
npm i -g pnpm
  1. Download file and rename to .env.local and move it into the root of your project. Get it here

  2. Download file and rename to .env and move it into /functions. Get it here

  3. Install dependencies

pnpm install --frozen-lockfile
  1. Run the project.
pnpm dev:next
  1. Website is lived at http://localhost:3000.

Contribution

On your local machine

  1. Create an issue for what you are working/fixing
  2. Create a new branch for the issue. Convention: <YourName>/<IssueNumber>-<ShortBranchDescription>
git fetch origin
git checkout origin/dev
git switch -c "Andrew/19-CreateProfile
  1. Update your local machine code
git pull origin dev --rebase
  1. Work on the issue, commit as you go
git commit -m "fix dog"
git commit -m "add cat"
  1. Check if your branch has any conflicts
git pull origin dev --rebase
  1. Fix conflicts if any

  2. Push to remote repo

git push origin <your-branch-name> --set-upstream
  1. Code review

Pull Request (Code Review)

  1. Create Pull Request

  2. Make sure all checks are passed (Linters and TypeScript)

  3. 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, use git push --force with caution as this will overwrite your previous work

  4. Repeat step 3 until your Pull Request is approved.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages