diff --git a/README.md b/README.md index 23223f116..e2a66b4e9 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@
- View Demo + View Demo ยท Report Bug ยท @@ -39,41 +39,51 @@ - -## About The Project - [![Product Name Screen Shot][product-screenshot]](https://example.com) -**Mealie** is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. Easily add recipes into your database by providing the url and mealie will automatically import the relevant data or add a family recipe with the UI editor. +# About The Project -Mealie also provides a secure API for interactions from 3rd party applications. **Why does my recipe manager need an API?** An API allows integration into applications like [Home Assistant]() that can act as notification engines to provide custom notifications based of Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. See the section on [Meal Plan hooks](#hooks) for more information. Additionally, you can access any available API from the backend server. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation. +Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family. Easily add recipes into your database by providing the url and Mealie will automatically import the relevant data or add a family recipe with the UI editor. Mealie also provides an API for interactions from 3rd party applications. + +[Remember to join the Discord](https://discord.gg/R6QDyJgbD2)! -### Main Features -#### Recipes - - Automatic web scrapping for common recipe platforms - - Interactive API Documentation thanks to [FastAPI](https://fastapi.tiangolo.com/) and [Swagger](https://petstore.swagger.io/) - - UI Recipe Editor - - JSON Recipe Editor in browser - - Custom tags and categories - - Rate recipes - - Add notes to recipes -#### Meal Planner - - Random Meal plan generation based off categories - - Expose notes in the API to allow external applications to access relevant information for meal plans - - Shopping Lists -#### Database Import / Export - - Easily Import / Export your recipes from the UI - - Export recipes in into custom files using Jinja2 templates +## Key Features +- ๐Ÿ” Fuzzy search +- ๐Ÿท๏ธ Tag recipes with categories or tags to flexible sorting +- ๐Ÿ•ธ Import recipes from around the web by URL +- ๐Ÿ“ฑ Beautiful Mobile Views +- ๐Ÿ“† Create Meal Plans +- ๐Ÿ›’ Generate shopping lists +- ๐Ÿณ Easy setup with Docker +- ๐ŸŽจ Customize your interface with color themes layouts +- ๐Ÿ’พ Export all your data in any format with Jinja2 Templates, with easy data restoration from the user interface. +- ๐ŸŒ localized in many languages +- โž• Plus tons more! + - Flexible API + - Custom key/value pairs for recipes + - Webhook support + - Interactive API Documentation thanks to [FastAPI](https://fastapi.tiangolo.com/) and [Swagger](https://petstore.swagger.io/) + - Raw JSON Recipe Editor + - Migration from other platforms + - Chowdown + - Nextcloud Cookbook + - Random meal plan generation -### Built With +## FAQ -* [Vue.js](https://vuejs.org/) -* [Vuetify](https://vuetifyjs.com/en/) -* [FastAPI](https://fastapi.tiangolo.com/) -* [Docker](https://www.docker.com/) +### Why An API? +An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based of Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access nearly any backend service via the API giving you total control to extend the application. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation. + +### Why a Database? +Some users of static-site generator applications like ChowDown have expressed concerns about their data being stuck in a database. Considering this is a new project it is a valid concern to be worried about your data. Mealie specifically addresses this concern by provided automatic daily backups that export your data in json, plain-text markdown files, and/or custom Jinja2 templates. **This puts you in controls of how your data is represented** when exported from Mealie, which means you can easily migrate to any other service provided Mealie doesn't work for you. + +As to why we need a database? + +- **Developer Experience:** Without a database a lot of the work to maintain your data is taken on by the developer instead of a battle tested platform for storing data. +- **Multi User Support:** With a solid database as backend storage for your data Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time. @@ -87,7 +97,6 @@ If you are not a coder, you can still contribute financially. financial contribu ## License - Distributed under the MIT License. See `LICENSE` for more information. @@ -97,16 +106,6 @@ Project Link: [https://github.com/hay-kot/mealie](https://github.com/hay-kot/mea - -## Acknowledgements - -* [Talk Python Training for helping me learn python](https://training.talkpython.fm/) -* [Academind for helping me learn Javascript and Vue.js](https://academind.com/) - - - - - [contributors-shield]: https://img.shields.io/github/contributors/hay-kot/mealie.svg?style=flat-square