-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
101dae5
commit af07658
Showing
1 changed file
with
50 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,50 @@ | ||
| # FoodPlanerWG | ||
| ## Idea | ||
| This project originated from my WGs reoccuring problem of deciding the meal plans for the next days and | ||
| what we should cook. | ||
| This app has the purpose to plan your meals and share it with a certain group of people such as | ||
| a WG or a family. | ||
| ## Features | ||
| It also Features such as: | ||
| - Meal planer with Drang n Drop function | ||
| - Shopping list | ||
| - Inventory list | ||
| - Create own meals | ||
| - Search for meals | ||
| - Random meal shuffle | ||
| - Search for Ingredients | ||
| - Tags for better search results (can be added to ingredients and meals) | ||
| - ai auto tagging (later) | ||
| - and much more | ||
| # NaMahlzeit! 🍽️ | ||
| *NaMahlzeit* is a web application designed to simplify meal planning for shared living spaces, families, or any group that wants to coordinate meals efficiently. Built with Django on the backend and React on the frontend, this app provides an intuitive interface for creating meal schedules, managing inventories, and more. | ||
|
|
||
| ## 🎯 Project Idea | ||
| This project originated from a common challenge in my shared apartment: deciding what to cook for the upcoming days. *NaMahlzeit* solves this by offering a collaborative space where users can plan meals, manage ingredients, and share their meal schedules with a group, making meal planning a hassle-free experience. | ||
|
|
||
| ## 🚀 Demo | ||
| Check out the live demo of the app [here](https://foodplaner-demo.robin-stark.com/login/). Feel free to log in with the provided test credentials to explore the features: | ||
| - **Username**: `TestUser` | ||
| - **Password**: `TestPassword17` | ||
|
|
||
| ## ✨ Features | ||
| - 📅 **Meal Planner** with drag-and-drop functionality | ||
| - 🛒 **Shopping List** automatically generated based on your meal plan | ||
| - 📦 **Inventory List** to track your ingredients | ||
| - 🍽️ **Create Your Own Meals** and save them for future use | ||
| - 🔍 **Meal and Ingredient Search** for easy browsing | ||
| - 🎲 **Random Meal Shuffle** for quick decision-making | ||
| - 🏷️ **Tags** for better search results, applicable to both ingredients and meals | ||
| - 📄 **Downloadable Data Dumps** for meals, ingredients, and tags | ||
| - 🔐 **User Authentication**: Log in and create new user accounts | ||
| - 🤖 **AI Auto Tagging** *(coming soon!)* | ||
|
|
||
| ## 🖼️ Screenshots | ||
| ### Meal Library | ||
|  | ||
|
|
||
| ### Weekly Planner | ||
|  | ||
|
|
||
| ### Shopping List | ||
|  | ||
|
|
||
| ## 🛠️ Tech Stack | ||
| - **Frontend**: React with TailwindCSS for styling and CSS animations | ||
| - **Backend**: Django for a robust, scalable backend | ||
| - **Database**: PostgreSQL | ||
|
|
||
| ## 📅 Roadmap | ||
| - [x] Implement meal planner with drag-and-drop | ||
| - [x] Generate shopping and inventory lists | ||
| - [x] Allow creation of custom meals and ingredient tagging | ||
| - [x] Provide data export options | ||
| - [ ] Implement AI-powered auto-tagging for enhanced meal suggestions | ||
|
|
||
| ## 🤝 Contributing | ||
| Feel free to fork this repository, make your changes, and submit a pull request. All contributions are welcome to improve this project. | ||
|
|
||
| ## 📄 License | ||
| This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |