README.md

Scavenge

Search for food you need at local food pantries and stay up-to-date on what's available!

Build Command Instructions

1. Clone the repository
2. Get the corrseponding ".env" file from a developer for both the "root" directory and "frontend" directory
3. npm install
4. cd backend
5. cd frontend
6. npm install

Run Instructions

1. Run web server: node server.js (localhost:8080)
   • You can run nodemon if you don't want to run the command above every backend change.
2. Run frontend: cd frontend and npm start in a different terminal (localhost:8081)

Testing Instructions

1. Frontend: in /frontend/

   Run npm run test-coverage

2. Backend: in the root directory (without the server running)

   Run npm run test

Other Information

• Design Document: https://docs.google.com/document/d/1lXOrrndHcP1GTYBJhzM4yFtvriI7gGU7x-HHDS9sx60/edit?usp=sharing
• Wireframes: https://www.figma.com/file/1d4cQQ8BKN6v5QrFM2sOku/Scavenge?node-id=85%3A337
• Postman API Docs: Please contact a developer to add you to our Postman collection.

Members

• Kenny: Project Leader / Backend Lead / Frontend Developer
• Email: klmui@wisc.edu@wisc.edu
• Ilkyu: Frontend Lead / Lead QA Tester
• Email: iju2@wisc.edu
• Andy: Frontend Developer
• Email: lin383@wisc.edu@wisc.edu
• Gleb: Frontend Developer
• Email: tsyganov@wisc.edu
• Jason: Frontend Developer
• Email: jsutanto2@wisc.edu
• Sean: Backend Developer / Database Administrator
• Email: sjcunningham@wisc.edu