Project Description

"What's for Dinner" is an open-source web application that suggests recipes based on the ingredients and cooking utensils you have on hand. With our platform, you can search for recipes using specific ingredients, add or remove ingredients to see different recipe suggestions, and save your favorite recipes for future use. Our app also includes advanced search filters such as dietary restrictions, meal type, and cooking time/difficulty to help find the perfect recipe for users at all levels.

Product Vision Statement

"What's for Dinner" is an app that helps users save time, reduce food waste, and enjoy the cooking process by providing optimal recipe suggestions based on the ingredients that users have available.

Meet Our Team

Abhi - link to github

Nancy - link to github

Alex - link to github

Chenyi - link to github

Hillary - link to github

History of the Project

We are a team of college students, and often after grocery shopping we have a few leftover ingredients that we don't know how to use or use effectively. Therefore, having an application that can help with giving us an optimal recipe based on the available ingredients can be very helpful in saving time, producing less waste when cooking, and enjopying the process.

Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to the project.

Instructions to Building and Testing the Project

Building

Front-end

1. first run cd front-end to navigate to front-end folder
2. then run npm install to install the front-end dependencies
3. create a .env file in the front-end directory with the following content:

PORT=3001
REACT_APP_SERVER=http://localhost:3000

Back-end

1. first run cd back-end to navigate to back-end folder
2. then run npm install to install the back-end dependencies
3. create a .env file in the back-end directory with the following content:

MEAL_DB_API_KEY=9973533
JWT_SECRET=whats.for.dinner
JWT_EXP_DAYS=60
MONGODB_URI=mongodb+srv://dinner:[email protected]/test?retryWrites=true&w=majority
SPOONACULAR_API_KEY=86b8ac3348974b5ab495921e201be0de
[email protected]
EMAIL_PASSWORD=nuzvkswprpbdvozh
CORS_ORIGIN=http://localhost:3001

*Note: For this project, we have provided the following credentials. However, for real projects, please visit "https://www.themealdb.com/" to create an account and replace <MEAL_DB_API_KEY> with your own API key. Similarly, replace <MONGODB_URI> and <SPOONACULAR_API_KEY> with your respective API keys.*

Running

1. If you are testing either the front-end or back-end, you can run npm start in the corresponding folder.
2. If you are running both the front-end and back-end together, run npm start separately in each folder and view the app on http://localhost:3001.
3. If you are using a Windows PC, please run npm run start-pc instead of npm start for the front-end.

Deployed front-end

To view our front-end code live on the web, go to https://monkfish-app-fjlpj.ondigitalocean.app/

Additional Resources

README.md - an overview of this project
LICENSE.md - the license under which this project is released
UX-DESIGN.md - the wireframe diagrams and prototype for this project

Important Note

This project is still in development, and we appreciate your patience and feedback as we work to improve the platform. If you have any questions or suggestions, please don't hesitate to reach out to us via the project's GitHub page.