My-Contacts

CSC 308/309 - LeContacts by William Last, Colin Bruins, Diego Nieves, Jeffrey Cheung, Peter Chinh

Links

• Production
• 1st Figma Prototype
• 2nd Figma Prototype
• Product/Tech Spec
• Final Presentation

Setup

1. Prerequisites: Make sure npm, Node.js, and Git are installed
2. Clone the project using "git clone https://github.com/peterchinh/my-contacts"
3. Run "npm install"
4. "cd backend" and create a .env file
5. While still in the backend, run "npm run dev" to load the backend locally
6. "cd ../" and run "npm start" to load the frontend

Making Changes

1. git pull
2. git checkout -b <name_of_branch>
3. change code
4. npm run lint

Committing

1. git add .
2. git commit -m "Action: Desc"
3. git push -u origin <name_of_branch>

PRS

1. Pull Request tab on github
2. Find pr, fill out template
3. Screenshot of work if applicable
4. Link pr to corresponding issue
5. request reviewer to check code
6. Merge code if approved

Style Guides

• Before Committing:
  • Run "npm run format"
  • Run "npm run lint"

Testing/Coverage Report

• Unit/Integration Tests
  • "cd backend"
  • Run "npm install supertest"
  • Run "npm run test"

• Acceptance Tests
  • Run "npm install cypress"
  • Run "npx cypress open" or "npx cypress run"
  • Backend needs to be running, or else one of the tests will fail.