|
1 | | - |
2 | | - |
3 | | - |
4 | | - |
5 | | - |
6 | | - |
7 | | - |
8 | | - <a id="about"> </a> |
| 1 | + |
| 2 | + |
| 3 | +<div > |
| 4 | + <img src="https://img.shields.io/github/repo-size/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 5 | + <img src="https://img.shields.io/github/issues-raw/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 6 | + <img src="https://img.shields.io/github/issues-closed-raw/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 7 | + <img src="https://img.shields.io/github/license/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 8 | + <img src="https://img.shields.io/github/issues-pr-raw/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 9 | + <img src="https://img.shields.io/github/issues-pr-closed-raw/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 10 | + <img src="https://img.shields.io/github/stars/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 11 | + <img src="https://img.shields.io/github/contributors/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 12 | + <img src="https://img.shields.io/github/forks/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 13 | + <img src="https://img.shields.io/github/last-commit/coder12git/Bon-Hack-tit?style=for-the-badge" /> |
| 14 | +</div> |
| 15 | + |
| 16 | +<br> |
9 | 17 |
|
10 | 18 | # FoodMeets |
11 | 19 |
|
12 | | - |
13 | | - |
14 | | - |
15 | 20 | Plan your meals with ease, from weekly menus to random recipes and ingredient-based suggestions. |
16 | 21 |
|
| 22 | +## Project Overview |
| 23 | +> The goal of this web application is to provide a convenient and efficient solution for meal planning, recipe generation, and nutrient tracking for busy individuals. The application aims to make meal planning more accessible and enjoyable by offering the following key features: |
17 | 24 |
|
18 | | -**Project Demo** - [FoodMeets](https://youtu.be/dWX_AudCbIM) |
19 | | - |
20 | | - |
21 | | -**Try out** - [FoodMeets](https://bon-hack-tit.suruchikumari1.repl.co/) |
22 | | - |
23 | | - |
| 25 | +> **Create your weekly menu** |
| 26 | +> |
| 27 | +> Users can customize their meal plans by specifying their dietary details, target calorie intake, preferred cuisines, and ingredients they want to include or exclude from recipes. |
| 28 | +> The application generates recipe ideas that align with users' nutritional needs and taste preferences, relieving them of the stress of meal planning. |
24 | 29 |
|
| 30 | +> **What's in your fridge** |
| 31 | +> |
| 32 | +> Users can make the most of the ingredients they already have at home. |
| 33 | +> By inputting the ingredients they have on hand and the desired number of recipes, users can access a variety of recipe ideas that inspire their meals and reduce food waste. |
25 | 34 |
|
| 35 | +> **Try something new today** |
| 36 | +> |
| 37 | +> This feature is designed for users looking to add variety to their meal rotation. |
| 38 | +> Users can select tags and specify the number of recipes they want to explore, allowing them to discover new and exciting recipes and expand their culinary horizons. |
26 | 39 |
|
27 | | -## How to Setup |
| 40 | +> **Bookmark and Popular Recipes** |
| 41 | +> |
| 42 | +> Users can bookmark their favorite recipes for easy access later on. |
| 43 | +> The bookmarked recipes are showcased in the popular recipes section when users revisit the site, providing inspiration and promoting user engagement. |
28 | 44 |
|
29 | | -1) Install [Node js](https://nodejs.org/en/download/) |
| 45 | +> **Download meal plans and recipe lists** |
| 46 | +> |
| 47 | +> Users can download their weekly menus and recipe lists in a PDF file format. |
| 48 | +> This feature offers users the convenience of accessing their meal plans and recipes offline, allowing them to refer to them anytime, anywhere. |
| 49 | +> Users can even print out the PDF files if needed, enhancing the accessibility and usability of the application. |
30 | 50 |
|
31 | | -2) Clone the repository |
32 | | -``` |
33 | | -git clone https://github.com/coder12git/Bon-Hack-tit.git |
| 51 | +## Project Highlights |
34 | 52 |
|
35 | | -``` |
| 53 | +We aim to provide users with a user-friendly, efficient, and personalized solution for meal planning and recipe generation by providing the following features: |
36 | 54 |
|
37 | | -3) To install dependencies run |
38 | | -``` |
39 | | -npm i |
| 55 | +- **Customized Meal Planning**: The web application allows users to create personalized meal plans based on their diet details, target calories, preferred cuisines, and ingredient preferences. This feature takes the stress out of meal planning by providing recipe ideas that align with users' nutritional needs and taste preferences. |
| 56 | +- **Ingredient Optimization**: The "What's in your fridge" feature helps users make the most of the ingredients they already have at home. By inputting their available ingredients, users can generate a variety of recipe ideas, reducing food waste and saving money by utilizing what they already have. |
| 57 | +- **Culinary Exploration**: The "Try something new today" feature enables users to explore new recipes and expand their culinary horizons. By selecting tags and specifying the number of recipes they want, users can discover exciting and diverse meal options, adding variety to their meal rotation. |
| 58 | +- **Bookmarking Favorite Recipes**: Users have the ability to bookmark their favorite recipes within the application. This feature allows users to easily access and revisit their preferred recipes, promoting user engagement and providing a personalized experience. |
| 59 | +- **PDF Download Capability**: The web application offers the convenience of downloading weekly menus and recipe lists in PDF format. Users can access their meal plans and recipes offline, making it easy to reference and follow their plans while on the go. Additionally, the option to print the PDF files enhances accessibility and usability for users who prefer physical copies. |
| 60 | +- **User-Friendly Interface**: The web application provides a user-friendly interface that is easy to navigate and understand. Users can input their preferences and retrieve recipe suggestions effortlessly, making the meal planning process efficient and enjoyable. |
40 | 61 |
|
41 | | -``` |
42 | | - |
43 | | -4) To start the server run |
44 | | -``` |
45 | | -npm start |
| 62 | +<div align='center'> |
| 63 | + |
| 64 | +<h2>Tools and Technologies Used</h2> |
| 65 | +<p align="center"> |
| 66 | +<a href="https://skillicons.dev"> |
| 67 | +<img src="https://skillicons.dev/icons?i=html,css,js,tailwindcss,nodejs,express,mongodb"/> |
| 68 | +</a> |
| 69 | +<h3>Website: <a href = "https://bon-hack-tit.suruchikumari1.repl.co/">https://bon-hack-tit.suruchikumari1.repl.co/</a></h3> |
| 70 | +</p> |
46 | 71 |
|
47 | | -``` |
| 72 | +<h2>Screenshots</h2> |
48 | 73 |
|
| 74 | + |
49 | 75 |
|
50 | | -## Sample menu and recipe |
| 76 | + |
51 | 77 |
|
| 78 | + |
52 | 79 |
|
53 | | - |
| 80 | + |
54 | 81 |
|
| 82 | +<h2>Demo</h2> |
55 | 83 |
|
56 | | - |
57 | 84 |
|
58 | 85 |
|
59 | | - |
| 86 | +https://github.com/coder12git/Bon-Hack-tit/assets/108334168/e0f51ae1-c35e-4c5a-9aa9-f7ad7744f850 |
60 | 87 |
|
61 | 88 |
|
62 | | -## What it does |
63 | | -Our web application is designed to make meal planning more convenient and efficient for busy individuals. With three key features, users can easily create a weekly menu based on their dietary needs and preferences, generate recipes based on the ingredients they have on hand, and try something new with exciting recipe ideas. |
64 | 89 |
|
65 | | -The first feature, |
66 | | -- **Create your weekly menu**: Allows users to customize their meal plan by inputting their diet details, target calories, preferred cuisines, and ingredients they want to include or exclude from recipes. This feature takes the stress out of meal planning by providing users with recipe ideas that meet their nutritional needs and taste preferences. |
| 90 | +</div> |
67 | 91 |
|
68 | | -The second feature, |
69 | | -- **What's in your fridge**: Allows users to make the most of the ingredients they already have at home. By inputting the ingredients they have on hand and the number of recipes they want to generate, users can easily access a variety of recipe ideas to inspire their meals and reduce food waste. |
| 92 | +## Setting up Local Development |
70 | 93 |
|
71 | | -The third feature, |
72 | | -- **Try something new today**: It is perfect for users looking to add some variety to their meal rotation. By selecting tags and the number of recipes they want, users can explore new recipes and expand their culinary horizons. |
| 94 | +1. Clone the repository |
73 | 95 |
|
74 | | -Additionally, we wanted to provide users with **a convenient way to access their meal plans and recipes without having to constantly log into our web application**. That's why we added a feature that allows users to **download their menus and recipe lists in a PDF file**. This way, users can easily access their meal plans and recipes offline, and even print them out if needed. We believe that this feature adds a lot of value to our application, making it even more convenient and user-friendly for busy people who are always on the go. |
| 96 | +``` |
| 97 | +git clone https://github.com/coder12git/Bon-Hack-tit.git |
| 98 | +``` |
75 | 99 |
|
76 | | -Overall, our web application provides a user-friendly and efficient solution for meal planning, recipe generation, and nutrient tracking to help busy individuals make healthier and more delicious meals every day. |
| 100 | +2. Navigate to the project folder |
77 | 101 |
|
| 102 | +``` |
| 103 | +cd Bon-Hack-tit/ |
| 104 | +``` |
78 | 105 |
|
79 | | -## How it works |
80 | | -To use **FoodMeets**, start by navigating to the home page and selecting one of the three features available. For example, if you want to plan out your weekly menu, select the "Create Your Weekly Menu" feature. Next, enter details such as your dietary preferences, target calories, cuisine preferences, and any ingredients you want to include or exclude from your recipes. Once you've entered all the necessary information, click the submit button. |
| 106 | +3. Install dependencies |
81 | 107 |
|
82 | | -You will then be taken to a page where you can see your weekly menus. Click on any of the meals to see the complete recipe for that meal, including ingredients and instructions on how to prepare it. If you want to save the recipe for later, simply click on the download button to download the recipe as a .pdf file. |
| 108 | +``` |
| 109 | +npm install |
| 110 | +``` |
83 | 111 |
|
84 | | -Similarly, you can use the other two features of FoodMeets, "What's In Your Fridge" and "Try Something New Today," by following the same process of entering the necessary details and clicking the submit button. |
| 112 | +4. Create a file named `.env` in the root directory of the project |
85 | 113 |
|
| 114 | +5. Copy contents of `env.example` to `.env` and replace all the environment variables |
86 | 115 |
|
| 116 | +6. To start the server run |
87 | 117 |
|
| 118 | +``` |
| 119 | +npm start |
| 120 | +``` |
88 | 121 |
|
| 122 | +<hr/> |
89 | 123 |
|
| 124 | +<div align='center'> |
| 125 | + <h3>Thanks for visiting!</h3> |
| 126 | +</div> |
0 commit comments