/4-final-project-chef-it-up

4-final-project-chef-it-up created by GitHub Classroom

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Chef-It-Up

Product Vision Statement

We want an app that will track specified ingredients for a user to prevent food waste, and give users options and recipes to utilize their stored ingredients to help them use their current items as well as improve their skills as chefs.

Project History

A common problem for many households is groceries and store goods going bad due to oversight and lack of knowledge of how to use them with whatever remaining ingredients. We wanted to make an app to combat this problem and make it much easier to avoid food wastage as well as get people to try new dishes and be more apt in the kitchen.

Contributing

How to contribute to Chef-It-Up

Team Members

Kei Oshima Ryan Horng Walid Al-Eisawi

Instruction and Methods

Website Access Option

Through Digital Ocean deployment, you can follow this link to use our app: Chef-It-Up

Github Repository Cloning Option

Alternatively, you can clone this repository and run Chef-It-Up locally. To setup and run our project, follow the instructions below:

Clone this repository to your local machine.

Navigate into the project directory.

Build and launch the back-end.

  1. Navigate into the back-end directory.
  2. Run npm install to install all dependencies listed in the package.json file.
  3. Run npm start to launch the back-end server.

Build and launch the front-end

  1. Navigate into the front-end directory.
  2. Run npm install to install all dependencies listed in the package.json file.
  3. Run npm start to launch the front-end server.

Testing

Run npm test to view the results of the unit tests and the code coverage.