You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"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.
@@ -30,7 +31,9 @@ Please refer to the [CONTRIBUTING.md](https://github.com/agiledev-students-sprin
30
31
## Instructions to Building and Testing the Project
31
32
32
33
### Building
34
+
33
35
**Front-end**
36
+
34
37
1. first run `cd front-end` to navigate to front-end folder
35
38
2. then run `npm install` to install the front-end dependencies
36
39
3. create a `.env` file in the front-end directory with the following content:
*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.*
57
60
58
61
### Running
59
-
1. If you are testing either the front-end or back-end, you can run npm start in the corresponding folder.
60
-
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.
61
-
3. If you are using a Windows PC, please run npm run start-pc instead of npm start for the front-end.
62
+
1. If you are testing either the front-end or back-end, you can run `npm start` in the corresponding folder.
63
+
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.
64
+
3. If you are using a Windows PC, please run `npm run start-pc` instead of `npm start` for the front-end.
62
65
63
66
## Deployed front-end
64
67
To view our front-end code live on the web, go to https://monkfish-app-fjlpj.ondigitalocean.app/
65
68
69
+
66
70
## Additional Resources
71
+
67
72
[README.md](https://github.com/agiledev-students-spring-2023/final-project-what-s-for-dinner/blob/master/README.md) - an overview of this project<br>
68
73
[LICENSE.md](https://github.com/agiledev-students-spring-2023/final-project-what-s-for-dinner/blob/master/LICENSE.md) - the license under which this project is released<br>
69
74
[UX-DESIGN.md](https://github.com/agiledev-students-spring-2023/final-project-what-s-for-dinner/blob/master/UX-DESIGN.md) - the wireframe diagrams and prototype for this project
70
75
71
-
### Important Note:
72
-
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.
76
+
### Important Note
77
+
78
+
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.
0 commit comments