github/mealie
1
0
Fork 0
mirror of https://github.com/hay-kot/mealie.git synced 2025-08-22 14:33:33 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 20

docs/new gifs & general updates

Browse source
This commit is contained in:
Hayden 2021-02-06 13:42:44 -09:00
commit 3cc3825bbe
16 changed files with 74 additions and 108 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.vscode/settings.json vendored
View file

@ -14,5 +14,8 @@
"python.testing.pytestArgs": ["mealie"],
"i18n-ally.localesPaths": "frontend/src/locales",
"i18n-ally.enabledFrameworks": ["vue"],
"i18n-ally.keystyle": "nested"
"i18n-ally.keystyle": "nested",
"cSpell.words": [
"performant"
]
}

2
README.md
View file

@ -33,7 +33,7 @@
Request Feature
</a>
·
<a href="https://hub.docker.com/repository/docker/hkotel/mealie"> Docker Hub
<a href="https://hub.docker.com/r/hkotel/mealie"> Docker Hub
</a>
</p>

44
docs/docs/changelog.md
View file

@ -9,23 +9,25 @@ This is, what I think, is a big release! Tons of new features and some great qua
### Bug Fixes
- Remove ability to save recipe with no name
- Fixed data validation error on missing parameters
- Fixed failed database initialization at startup
- Fixed failed database initialization at startup - Closes #98
- Fixed misaligned text on various cards
- Fixed bug that blocked opening links in new tabs
- Fixed router link bugs - Issue #122
- Fixed bug that blocked opening links in new tabs - Closes #122
- Fixed router link bugs - Closes #122
- Fixed navigation on keyboard selection - Closes #139
### Features and Improvements
- 🐳 Dockerfile now 1/5 of the size!
- 🌎 UI Language Selection + Additional Supported Language
- **Home Page**
- Sections: By default your homepage will display only the recently added recipes. You can configured sections to show on the home-screen based of categories on the settings page.
- Sidebar: A new sidebar is now shown on the main page that lists all the categories in the database. Clicking on them navigates into a page that shows only recipes.
- Sort: Basic Sort functionality has been added. More options are on the way!
- By default your homepage will display only the recently added recipes. You can configured sections to show on the home-screen based of categories on the settings page.
- A new sidebar is now shown on the main page that lists all the categories in the database. Clicking on them navigates into a page that shows only recipes.
- Basic Sort functionality has been added. More options are on the way!
- **Meal Planner**
- Improved Search (Fuzzy Search)
- New Scheduled card support
- Upload/Download backups
- **Recipe Editor**
- Ingredients are now sortable via drag-and-drop
- Known categories now show up in the dropdown
- Known categories now show up in the dropdown - Closes 83
- Initial code for data validation to prevent errors
- **Migrations**
- Card based redesign
@ -36,11 +38,11 @@ This is, what I think, is a big release! Tons of new features and some great qua
- Major Endpoint refactor
- Improved API documentation
- Link to your Local API is now on your `/settings/site`. You can use it to explore your API.
- :whale: Dockerfile now 1/5 of the size!
- UI Language Selection + Additional Supported Language
- Continued work on button/style unification
- Adding icons to buttons
- New Color Theme Picker UI
- **Style**
- Continued work on button/style unification
- Adding icons to buttons
- New Color Theme Picker UI
### Development
- Fixed Vetur config file. Autocomplete in VSCode works!
@ -59,9 +61,9 @@ This is, what I think, is a big release! Tons of new features and some great qua
## v0.1.0 - Initial Beta
### Bug Fixes
- Fixed Can't delete recipe after changing name - Closes Issue #67
- Fixed No image when added by URL, and can't add an image - Closes Issue #66
- Fixed Images saved with no way to delete when add recipe via URL fails - Closes Issue #43
- Fixed Can't delete recipe after changing name - Closes Closes #67
- Fixed No image when added by URL, and can't add an image - Closes Closes #66
- Fixed Images saved with no way to delete when add recipe via URL fails - Closes Closes #43
### Features
- Additional Language Support
@ -95,8 +97,8 @@ A quality update with major props to [zackbcom](https://github.com/zackbcom) for
- Fixed empty backup failure without markdown template
- Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31)
- Fixed hot-reloading development environment - [grssmnn](https://github.com/grssmnn)
- Fixed recipe not saving without image - Issue #7 + Issue #54
- Fixed parsing error on image property null - Issue #43
- Fixed recipe not saving without image - Closes #7 + Closes #54
- Fixed parsing error on image property null - Closes #43
### General Improvements
- Added Confirmation component to deleting recipes - [zackbcom](https://github.com/zackbcom)
@ -109,7 +111,7 @@ A quality update with major props to [zackbcom](https://github.com/zackbcom) for
- Users can now add custom json key/value pairs to all recipes via the editor for access in 3rd part applications. For example users can add a "message" field in the extras that can be accessed on API calls to play a message over google home.
- Improved image rendering (nearly x2 speed)
- Improved documentation + API Documentation
- Improved recipe parsing - Issue #51
- Improved recipe parsing - Closes #51
- User feedback on backup importing
## v0.0.1 - Pre-release Patch
@ -120,8 +122,8 @@ A quality update with major props to [zackbcom](https://github.com/zackbcom) for
### Recipes
- Added user feedback on bad URL
- Better backend data validation for updating recipes, avoid small syntax errors corrupting database entry. [Issue #8](https://github.com/hay-kot/mealie/issues/8)
- Fixed spacing issue while editing new recipes in JSON
- Better backend data validation for updating recipes, avoid small syntax errors corrupting database entry. [Closes #8](https://github.com/hay-kot/mealie/issues/8)
- Fixed spacing Closes while editing new recipes in JSON
## v0.0.0 - Initial Pre-release
The initial pre-release. It should be semi-functional but does not include a lot of user feedback You may notice errors that have no user feedback and have no idea what went wrong.

3
docs/docs/getting-started/backups-and-exports.md
View file

@ -1,5 +1,4 @@
# Backup and Imports
![](../img/admin-backup.png)
All recipe data can be imported and exported as necessary from the UI. Under the admin page you'll find the section for using Backups and Exports.
@ -7,6 +6,8 @@ To create an export simple add the tag and the markdown template and click Backu
To import a backup it must be in your backups folder. If it is in the backup folder it will automatically show up as an source to restore from. Selected the desired backup and import the backup file.
![](../gifs/backup-demo-v1.gif)
## Custom Templating
On export you can select a template to use to render files using the jinja2 syntax. This can be done to export recipes in other formats besides regular .json.Look at this example for rendering a markdown recipe using the jinja2 syntax.

25
docs/docs/getting-started/install.md
View file

@ -1,5 +1,5 @@
# Installation
To deploy docker on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose below you should be able to get a stack up and running easily by changing a few default values and deploying. Currently MongoDB and SQLite are supported. MongoDB support will be dropped in v0.2.0 so it is recommended to go with SQLite for new deployments. Postrgres support is planned for the next release, however for most loads you may find SQLite performant enough.
To deploy docker on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose below you should be able to get a stack up and running easily by changing a few default values and deploying. Currently MongoDB and SQLite are supported. MongoDB support will be dropped in v0.2.0 so it is recommended to go with SQLite for new deployments. Postrgres support is planned, however for most loads you may find SQLite performant enough for most use cases.
[Get Docker](https://docs.docker.com/get-docker/)
@ -14,7 +14,7 @@ Deployment with the Docker CLI can be done with `docker run` and specify the dat
docker run \
-e db_type='sqlite' \
-p 9000:80 \
-v `pwd`:'/app/data/' \
-v `pwd`:'/app_data/' \
hkotel/mealie:latest
```
@ -35,24 +35,19 @@ services:
db_type: sqlite
TZ: America/Anchorage
volumes:
- ./mealie/data/:/app/data
- ./mealie/data/:/app_data
```
## Env Variables
| Variables | default | description |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| db_type | sqlite | The database type to be used. Current Options 'sqlite' |
| mealie_db_name | mealie | The name of the database to be created in Mongodb |
| mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. |
| db_username | root | The Mongodb username you specified in your mongo container |
| db_password | example | The Mongodb password you specified in your mongo container |
| db_host | mongo | The host address of MongoDB if you're in docker and using the same network you can use mongo as the host name |
| db_port | 27017 | the port to access MongoDB 27017 is the default for mongo |
| api_docs | True | Turns on/off access to the API documentation locally. |
| TZ | | You should set your time zone accordingly so the date/time features work correctly |
| Variables | default | description |
| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| db_type | sqlite | The database type to be used. Current Options 'sqlite' |
| mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. |
| api_docs | True | Turns on/off access to the API documentation locally. |
| TZ | | You should set your time zone accordingly so the date/time features work correctly |
## Deployed as a Python Application
Alternatively, this project is built on Python and Mongodb. If you are dead set on deploying on a linux machine you can run this in an python environment with a dedicated MongoDatabase. Provided that you know thats how you want to host the application, I'll assume you know how to do that. I may or may not get around to writing this guide. I'm open to pull requests if anyone has a good guide on it.
Alternatively, this project is built on Python and SQLite. If you are dead set on deploying on a linux machine you can run this in an python virtual env. Provided that you know thats how you want to host the application, I'll assume you know how to do that. I may or may not get around to writing this guide. I'm open to pull requests if anyone has a good guide on it.

2
docs/docs/getting-started/meal-planner.md
View file

@ -8,4 +8,4 @@ To edit the meal in a meal plan simply select the edit button on the card in the
!!! warning
In coming a future release recipes for meals will be restricted to specific categories.
![](../gifs/meal-plan-demo.gif)
![](../gifs/meal-plan-demo-v2.gif)

2
docs/docs/getting-started/recipes.md
View file

@ -10,7 +10,7 @@ Adding a recipe can be as easy as copying the recipe URL into mealie and letting
## Recipe Editor
Recipes can be edited and created via the UI. This is done with both a form based approach where you have a UI to work with as well as with a in browser JSON Editor. The JSON editor allows you to easily copy and paste data from other sources.
You can also add a custom recipe with the UI editor built into the web view. After logging in as a user you'll have access to the editor to make changes to all the content in the recipe.
You can also add a custom recipe with the UI editor built into the web view.
![](../gifs/editor-demo.gif)

12
docs/docs/getting-started/site-settings.md
View file

@ -2,18 +2,22 @@
!!! danger
As this is still a **BETA** It is recommended that you backup your data often and store in more than one place. Ad-hear to backup best practices with the [3-2-1 Backup Rule](https://en.wikipedia.org/wiki/Backup)
## General Settings
In your site settings page you can select several options to change the layout of your homepage. You can choose to display the recent recipes, how many cards to show for each section, and which category sections to display. You can additionally select which language to use by default. Note the currently homepage settings are saved in your browser. In the future a database entry will be made for site settings so the homepage is consistent across users.
![](../gifs/homepage-settings-v1.gif)
## Theme Settings
Color themes can be created and set from the UI in the settings page. You can select an existing color theme or create a new one. On creation of a new color theme, the default colors will be used, then you can select and save as you'd like. By default the "default" theme will be loaded for all new users visiting the site. All created color themes are available to all users of the site. Theme Colors will be set for both light and dark modes.
![](../gifs/theme-demo.gif)
![](../gifs/theme-demo-v2.gif)
!!! note
Theme data is stored in localstorage in the browser. Calling "Save colors and apply theme will refresh the localstorage with the selected theme as well save the theme to the database.
Theme data is stored in localstorage in the browser. Calling "Save colors and apply theme will refresh the local storage with the selected theme as well save the theme to the database.
## Backups
Site backups can easily be taken and download from the UI. To import, simply select the backup you'd like to restore and check which items you'd like to import.
## Meal Planner Webhooks
Meal planner webhooks are post requests sent from Mealie to an external endpoint. The body of the message is the Recipe JSON of the scheduled meal. If no meal is schedule, no request is sent. The webhook functionality can be enabled or disabled as well as scheduled. Note that you must "Save Webhooks" prior to any changes taking affect server side.

BIN
docs/docs/gifs/backup-demo-v1.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.8 MiB

BIN
docs/docs/gifs/homepage-settings-v1.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.9 MiB

BIN
docs/docs/gifs/meal-plan-demo-v2.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.4 MiB

BIN
docs/docs/gifs/meal-plan-demo.gif
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 14 MiB

BIN
docs/docs/gifs/theme-demo-v2.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.5 MiB

BIN
docs/docs/gifs/theme-demo.gif
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 5.7 MiB

38
docs/docs/index.md
View file

@ -25,9 +25,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 relevant 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. Mealie also provides an API for interactions from 3rd party applications.
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.
**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.
[Remember to join the Discord](https://discord.gg/R6QDyJgbD2)!
@ -35,29 +35,37 @@ Mealie also provides an API for interactions from 3rd party applications. **Why
In some of the demo gifs the styling may be different than the finale application. demos were done during development prior to finale styling.
!!! warning
Note that this is a **ALPHA** 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. That said, one of the nice things about MongoDB is that it's flexible!
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,
### 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
- Migration From Other Platforms
- UI recipe editor
- JSON recipe editor
- Additional recipe data
- custom notes
- ratings
- categories and tags
- total, cook, and prep time indicators
- View recipes by category
- Basic fuzzy search
- Migration from other platforms
- Chowdown
- Open Eats - **Coming Soon**
- Nextcloud Cookbook
#### 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
- Random meal plan generation
#### API
- The entire application is built on a restful API and can be accessed by the user
- Scheduled Webhooks
- Interactive API Documentation thanks to [FastAPI](https://fastapi.tiangolo.com/) and [Swagger](https://petstore.swagger.io/)
- 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 markdown format for universal access
- 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
### Built With

49
docs/docs/roadmap.md
View file

@ -1,51 +1,4 @@
# Development Road Map
!!! Current Release
v0.1.0 BETA - This is technically a pre-release, as such take care to backup data and be aware that breaking changes in future releases are a real possibility.
Feature placement is not set in stone. This is much more of a guideline than anything else.
## v x.x.x - No planned target, but eventually...
### Frontend
- [ ] Login / Logout Navigation
* [ ] Initial Page
* [ ] Logic / Function Calls
* [ ] Password Reset
### Backend
- [ ] Image Minification
- [ ] User Setup
* [ ] Authentication
* [ ] Default Admin/Superuser Account
* [ ] Password Reset
* [ ] User Accounts
* [ ] Edit / Delete
## v0.2.0 - Targets
!!! error "MAJOR BREAKING CHANGE"
MongoDB will no longer be supported as of v0.2.0. Review the database migration page for details on migration to SQL (It's very easy)
## New Features
### Frontend
- [ ] Advanced search
- [ ] Category Filter
- [ ] Tag Filter
- [x] Fuzzy Search
- [x] Backup card redesign
- [ ] Additional Backup / Import Features
- [ ] Import Recipes Force/Rebase options
- [x] Upload .zip file
- [x] Improved Color Picker
- [x] Meal Plan redesign
### Backend
- [ ] PostgreSQL Support
- [ ] Setup SQL Migrations
## Breaking Changes
- MongoDB support dropped
## Code Chores
- [x] Remove MongoDB Interface Code
- [x] Dockerfile Trim
See the [Github META issue for tracking the Road Map](https://github.com/hay-kot/mealie/issues/122)