mirror of
https://github.com/mealie-recipes/mealie.git
synced 2026-01-06 09:01:21 -05:00
updated docs
This commit is contained in:
@@ -14,9 +14,9 @@
|
||||
|
||||
![Product Name Screen Shot][product-screenshot]
|
||||
|
||||
**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 relavent data or add a family recipe with the UI editor.
|
||||
**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.
|
||||
|
||||
Melaie 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](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 any avaiable 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 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](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 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.
|
||||
|
||||
!!! note
|
||||
In some of the demo gifs the styling may be different than the finale application. demos were done during development prior to finale styling.
|
||||
@@ -35,9 +35,13 @@ Melaie also provides a secure API for interactions from 3rd party applications.
|
||||
- Custom tags and categories
|
||||
- Rate recipes
|
||||
- Add notes to recipes
|
||||
- Migration From Other Platforms
|
||||
- Chowdown
|
||||
- Open Eats - **Coming Soon**
|
||||
#### Meal Planner
|
||||
- Random Meal plan generation based off categories
|
||||
- Expose notes in the API to allow external applications to access relavent information for meal plans
|
||||
- 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 markdown format for universal access
|
||||
@@ -54,17 +58,9 @@ Melaie also provides a secure API for interactions from 3rd party applications.
|
||||
|
||||
|
||||
<!-- ROADMAP -->
|
||||
## Roadmap
|
||||
## Road Map
|
||||
|
||||
#### Authentication - Target 1.0
|
||||
- User Login
|
||||
- Token Based API Access/Auth
|
||||
|
||||
#### Recipe Sharing
|
||||
- Share Button / Email
|
||||
- Export to PDF
|
||||
- Print Button
|
||||
- Git Repo Based Sharing (Import / Export / Search)
|
||||
[See Roadmap](2.0 - roadmap)
|
||||
|
||||
|
||||
|
||||
@@ -73,6 +69,8 @@ Melaie also provides a secure API for interactions from 3rd party applications.
|
||||
|
||||
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.
|
||||
|
||||
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 the project.
|
||||
|
||||
<a href="https://www.buymeacoffee.com/haykot" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
||||
|
||||
<!-- LICENSE -->
|
||||
|
||||
Reference in New Issue
Block a user