About The Project
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.
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. 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.
In some of the demo gifs the styling may be different than the finale application. demos were done during development prior to finale styling.
Note that this is a BETA release and that means things may break and or change down the line. I'll do my best to make sure that any API changes are thoughtful and necessary in order not to break things. Additionally, I'll do my best to provide a migration path if the database schema ever changes. Do not use programs like watchtower to auto update your container. You WILL run into issues if you do this,
- Automatic web scrapping for common recipe platforms
- UI recipe editor
- JSON recipe editor
- Additional recipe data
- custom notes
- categories and tags
- total, cook, and prep time indicators
- View recipes by category
- Basic fuzzy search
- Migration from other platforms
- Nextcloud Cookbook
- Random meal plan generation
- The entire application is built on a restful API and can be accessed by the user
- Scheduled Webhooks
- Interactive API Documentation thanks to FastAPI and Swagger
- Custom "API Extras" in recipes for custom key/value pairs to extendable API uses
Database Import / Export
- Easily import / export your recipes from the UI
- Export recipes in any format for universal access using Jinja2
- Use the default or a custom jinja2 template
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Especially test. Literally any tests. See the Contributors Guide for help getting started.
If you are not a coder, you can still contribute financially. financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development.
Distributed under the MIT License. See
LICENSE for more information.
Project Link: https://github.com/hay-kot/mealie