Skip to content

Kooki-eByte/Forage

Repository files navigation

Forage

GitHub

Table of Contents

  1. Documentation

    1. Description
    2. Installation Instructions
    3. Usage Information
  2. Test Instructions

  3. Contribution Guideline

  4. Resources

  5. License

  6. Questions

Documentation

Description

  • Forage is a web application made for a user to sign in an account, calculate what your total calories consumption should be, can go to the food search button and select foods you want to add to either breakfast, lunch, dinner, and snacks. As well as a check out your foods that you saved. The users page will have a chart of how many foods are saved in each category to give users a quicker time to see what they would like to balance out.

Installation Instructions

  • To install this project you would have to click on the green button that says code and add in the terminal. To install the dependencies you would go to the terminal and make sure the directory is the repos name. Then go ahead and do a npm i to install all of the dependencies in this project. You will also need to create a .env file whuch we have a sample of on the file DO NOT DELETE THE FILE JUST MAKE A NEW .ENV FILE.

Usage Information

  • You would first have to create the database in the MySQL database and then lastly run the server in order to use the project, you would do this by doing npm run watch or npm run start either one will create the server and run the website.

Test Instructions

  • You can test api routes with postman

Contribution Guideline

  • The guideline to contribute will be to have a new branch and a descriptive pull request as to the changes you mde or add and why.

License

  • This Application is covered under the MIT License.

Resources

Questions

For any further questions checkout our github pages

About

Project 2 for UCF

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published