wbrawner/mealie
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
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
102 commits 1 branch 0 tags 368 MiB
Python 52.9%
Vue 35.4%
TypeScript 10%
JavaScript 0.7%
Dockerfile 0.5%
Other 0.4%
Find a file
Hayden df0d7c9ac5 api documentation
2021-01-07 19:51:11 -09:00
.github/workflows imrpove api docs 2021-01-07 15:25:01 -09:00
.vscode abstract dictionary assignemnt into a function 2021-01-05 17:08:33 -09:00
dev Merge pull request #35 from richardmitic/scraper_fixes 2021-01-05 13:35:34 -09:00
docs api documentation 2021-01-07 19:51:11 -09:00
frontend imrpove api docs 2021-01-07 15:25:01 -09:00
mealie api documentation 2021-01-07 19:51:11 -09:00
.dockerignore init 2 2020-12-24 16:37:38 -09:00
.gitattributes init 2 2020-12-24 16:37:38 -09:00
.gitignore api documentation 2021-01-07 19:51:11 -09:00
docker-compose.dev.yml More consistent names, added env var for frontend 2021-01-05 13:17:14 +01:00
docker-compose.yml docker file 2021-01-01 16:56:19 -09:00
Dockerfile Remove test directory in production docker image 2021-01-06 18:01:46 +01:00
Dockerfile.dev Normalize recipe instructions, yield, and image url 2021-01-05 22:19:32 +01:00
LICENSE init 2 2020-12-24 16:37:38 -09:00
README.md api documentation 2021-01-07 19:51:11 -09:00
requirements.dev.txt Normalize recipe instructions, yield, and image url 2021-01-05 22:19:32 +01:00
requirements.txt migration changes 2021-01-01 16:51:55 -09:00

README.md

Contributors Forks Stargazers Issues MIT License Docker Pulls


Mealie

A Place for All Your Recipes
Explore the docs »
View Demo · Report Bug · API · Request Feature · Docker Hub

About The Project

Product Name Screen Shot

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 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 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.

Main Features

Recipes

  • Automatic web scrapping for common recipe platforms
  • Interactive API Documentation thanks to FastAPI and Swagger
  • 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

Database Import / Export

  • Easily Import / Export your recipes from the UI
  • Export recipes in into custom files using Jinja2 templates

Built With

Contributing

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.

Buy Me A Coffee

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/hay-kot/mealie

Acknowledgements