mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-08-05 13:35:23 +02:00
v0.2.0 (#143)
* Changed uvicorn port to 80 * Changed port in docker-compose to match dockerfile * Readded environment variables in docker-compose * production image rework * Use opengraph metadata to make basic recipe cards when full recipe metadata is not available * fixed instrucitons on parse * add last_recipe * automated testing * roadmap update * Sqlite (#75) * file structure * auto-test * take 2 * refactor ap scheduler and startup process * fixed scraper error * database abstraction * database abstraction * port recipes over to new schema * meal migration * start settings migration * finale mongo port * backup improvements * migration imports to new DB structure * unused import cleanup * docs strings * settings and theme import logic * cleanup * fixed tinydb error * requirements * fuzzy search * remove scratch file * sqlalchemy models * improved search ui * recipe models almost done * sql modal population * del scratch * rewrite database model mixins * mostly grabage * recipe updates * working sqllite * remove old files and reorganize * final cleanup Co-authored-by: Hayden <hay-kot@pm.me> * Backup card (#78) * backup / import dialog * upgrade to new tag method * New import card * rename settings.py to app_config.py * migrate to poetry for development * fix failing test Co-authored-by: Hayden <hay-kot@pm.me> * added mkdocs to docker-compose * Translations (#72) * Translations + danish * changed back proxy target to use ENV * Resolved more merge conflicts * Removed test in translation * Documentation of translations * Updated translations * removed old packages Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com> * fail to start bug fixes * feature: prep/cook/total time slots (#80) Co-authored-by: Hayden <hay-kot@pm.me> * missing bind attributes * Bug fixes (#81) * fix: url remains after succesful import * docs: changelog + update todos * arm image * arm compose * compose updates * update poetry * arm support Co-authored-by: Hayden <hay-kot@pm.me> * dockerfile hotfix * dockerfile hotfix * Version Release Final Touches (#84) * Remove slim * bug: opacity issues * bug: startup failure with no database * ci/cd on dev branch * formatting * v0.1.0 documentation Co-authored-by: Hayden <hay-kot@pm.me> * db init hotfix * bug: fix crash in mongo * fix mongo bug * fixed version notifier * finale changelog * Dropping Mongo From Dev Branch (#89) * Fix link to Docker Hub Found an extra s. DESTROYED it. * initial pass * second pass cleanup * backup card framework * backup card functionality * translation * upload button vile creation * Release v0.1.0 Candidate (#85) * Changed uvicorn port to 80 * Changed port in docker-compose to match dockerfile * Readded environment variables in docker-compose * production image rework * Use opengraph metadata to make basic recipe cards when full recipe metadata is not available * fixed instrucitons on parse * add last_recipe * automated testing * roadmap update * Sqlite (#75) * file structure * auto-test * take 2 * refactor ap scheduler and startup process * fixed scraper error * database abstraction * database abstraction * port recipes over to new schema * meal migration * start settings migration * finale mongo port * backup improvements * migration imports to new DB structure * unused import cleanup * docs strings * settings and theme import logic * cleanup * fixed tinydb error * requirements * fuzzy search * remove scratch file * sqlalchemy models * improved search ui * recipe models almost done * sql modal population * del scratch * rewrite database model mixins * mostly grabage * recipe updates * working sqllite * remove old files and reorganize * final cleanup Co-authored-by: Hayden <hay-kot@pm.me> * Backup card (#78) * backup / import dialog * upgrade to new tag method * New import card * rename settings.py to app_config.py * migrate to poetry for development * fix failing test Co-authored-by: Hayden <hay-kot@pm.me> * added mkdocs to docker-compose * Translations (#72) * Translations + danish * changed back proxy target to use ENV * Resolved more merge conflicts * Removed test in translation * Documentation of translations * Updated translations * removed old packages Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com> * fail to start bug fixes * feature: prep/cook/total time slots (#80) Co-authored-by: Hayden <hay-kot@pm.me> * missing bind attributes * Bug fixes (#81) * fix: url remains after succesful import * docs: changelog + update todos * arm image * arm compose * compose updates * update poetry * arm support Co-authored-by: Hayden <hay-kot@pm.me> * dockerfile hotfix * dockerfile hotfix * Version Release Final Touches (#84) * Remove slim * bug: opacity issues * bug: startup failure with no database * ci/cd on dev branch * formatting * v0.1.0 documentation Co-authored-by: Hayden <hay-kot@pm.me> * db init hotfix * bug: fix crash in mongo * fix mongo bug * fixed version notifier * finale changelog Co-authored-by: kentora <=> Co-authored-by: Hayden <hay-kot@pm.me> Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com> Co-authored-by: kentora <kentora@kentora.dk> * build container * webscraper hotfix * dev bug: change data location to prevent reloads * api docs * api docs bug * workflow update Co-authored-by: David Young <davidy@funkypenguin.co.nz> Co-authored-by: Hayden <hay-kot@pm.me> Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com> Co-authored-by: kentora <kentora@kentora.dk> * Add French Translation (#93) * New tests (#94) * dev-bug: fixed vscode freezes * test: refactor database init to support tests Co-authored-by: Hayden <hay-kot@pm.me> * Mealplan CRUD Tests (#95) * dev-bug: fixed vscode freezes * test: refactor database init to support tests * mealplan CRUD testing Co-authored-by: Hayden <hay-kot@pm.me> * Fix typos (#96) * Settings, Themes and Migration Route Tests (#100) * dev-bug: fixed vscode freezes * test: refactor database init to support tests * mealplan CRUD testing * restructure test folder * git attributes * tests: migration, settings, theme routes testing Co-authored-by: Hayden <hay-kot@pm.me> * Refactor + New Docker File (#105) * dev-bug: fixed vscode freezes * test: refactor database init to support tests * mealplan CRUD testing * restructure test folder * git attributes * tests: migration, settings, theme routes testing * docker-file shrink * rebuild * refactor: moving directories around * adding funding Co-authored-by: Hayden <hay-kot@pm.me> * Meal planner improvements (#107) * dev-bug: fixed vscode freezes * test: refactor database init to support tests * mealplan CRUD testing * restructure test folder * git attributes * tests: migration, settings, theme routes testing * docker-file shrink * rebuild * refactor: moving directories around * adding funding * mealplan redesign Co-authored-by: Hayden <hay-kot@pm.me> * Upload component (#108) * unified upload button + download backups * javascript toolings * fix vuetur config * fixed type check error * refactor: clean up bag javascript Co-authored-by: Hayden <hay-kot@pm.me> * Upload component (#113) * unified upload button + download backups * javascript toolings * fix vuetur config * fixed type check error * refactor: clean up bag javascript * UI updates + name validation * docs: changelog + sp * fixed route links * changelog Co-authored-by: Hayden <hay-kot@pm.me> * fixed menu links * fixed poetry install on docker.dev build * Migration redesign (#119) * migration redesign init * new color picker * changelog * added UI language selection * fix layout issue on recipe editor * remove git as dependency * added UI editor for original URL * CI/CD Tests * test: fixed migration routes Co-authored-by: Hayden <hay-kot@pm.me> * Fix link to dev-notes.md (#110) * translation: add swedish (#128) * language: da is Danish * translations: add swedish * scraper: unescape html in instructions (#129) Some urls erroneously deliver escaped html their instructions, sometimes they are even escaped on multiple levels like here: https://www.ica.se/recept/kladdig-kladdkaka-722982/ ``` >>> normalize_instruction("S&auml;tt ugnen p&aring; 200&deg;C.") 'Sätt ugnen på 200°C.' ``` * v0.2.0 Updates (#130) * migration redesign init * new color picker * changelog * added UI language selection * fix layout issue on recipe editor * remove git as dependency * added UI editor for original URL * CI/CD Tests * test: fixed migration routes * test todos * bug/added docker volume * chowdow test data * partial image recipe image testing * added card section card * settings form * homepage cetegory ui * frontend category placeholder * fixed broken scheduler * remove old files * removed temp test Co-authored-by: Hayden <hay-kot@pm.me> * Fix missing translations key (#133) * translation: add simplified & traditional chinese * Fix missing translations * fix chinese translations * v0.2.0 Release Candidate (#141) * Fix link to Docker Hub Found an extra s. DESTROYED it. * Release v0.1.0 Candidate (#85) * Changed uvicorn port to 80 * Changed port in docker-compose to match dockerfile * Readded environment variables in docker-compose * production image rework * Use opengraph metadata to make basic recipe cards when full recipe metadata is not available * fixed instrucitons on parse * add last_recipe * automated testing * roadmap update * Sqlite (#75) * file structure * auto-test * take 2 * refactor ap scheduler and startup process * fixed scraper error * database abstraction * database abstraction * port recipes over to new schema * meal migration * start settings migration * finale mongo port * backup improvements * migration imports to new DB structure * unused import cleanup * docs strings * settings and theme import logic * cleanup * fixed tinydb error * requirements * fuzzy search * remove scratch file * sqlalchemy models * improved search ui * recipe models almost done * sql modal population * del scratch * rewrite database model mixins * mostly grabage * recipe updates * working sqllite * remove old files and reorganize * final cleanup Co-authored-by: Hayden <hay-kot@pm.me> * Backup card (#78) * backup / import dialog * upgrade to new tag method * New import card * rename settings.py to app_config.py * migrate to poetry for development * fix failing test Co-authored-by: Hayden <hay-kot@pm.me> * added mkdocs to docker-compose * Translations (#72) * Translations + danish * changed back proxy target to use ENV * Resolved more merge conflicts * Removed test in translation * Documentation of translations * Updated translations * removed old packages Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com> * fail to start bug fixes * feature: prep/cook/total time slots (#80) Co-authored-by: Hayden <hay-kot@pm.me> * missing bind attributes * Bug fixes (#81) * fix: url remains after succesful import * docs: changelog + update todos * arm image * arm compose * compose updates * update poetry * arm support Co-authored-by: Hayden <hay-kot@pm.me> * dockerfile hotfix * dockerfile hotfix * Version Release Final Touches (#84) * Remove slim * bug: opacity issues * bug: startup failure with no database * ci/cd on dev branch * formatting * v0.1.0 documentation Co-authored-by: Hayden <hay-kot@pm.me> * db init hotfix * bug: fix crash in mongo * fix mongo bug * fixed version notifier * finale changelog Co-authored-by: kentora <=> Co-authored-by: Hayden <hay-kot@pm.me> Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com> Co-authored-by: kentora <kentora@kentora.dk> * build container * webscraper hotfix * notes hot fix * bug: mongo updates fail #99 * Fix error message (#101) * gh funding * Create Issue Templates (#125) * Create bug_report.md * Create config.yml Included a link to feature requests. * Update config.yml Fixed link I had for testing to the actual link * Update bug_report.md fix capitalization * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com> Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com> * merge kentors changes * refactor/recipe routers * category/tag database relationship and endpoints * frontend category management * update branch todos * bug/normalize recipe steps html * remove console.log + refactor categories * fix categories database errors * refactor/ router endpoint * refactor/ remove old code * drag and drop ingredients * general cleanup * route refactoring * changelog * api refactoring + random cleanup * fixed backwards sort * Update mkdocs.yml (#137) Fix warning from Deploy Docs github action * fixed navigate on enter in search * refactor/create global css * added category scroll * cleanup todos * debug routes * docs/new gifs & general updates * cleanup * fix list test Co-authored-by: David Young <davidy@funkypenguin.co.nz> Co-authored-by: Hayden <hay-kot@pm.me> Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com> Co-authored-by: kentora <kentora@kentora.dk> Co-authored-by: Alexei Pesic <pesic.alexei@gmail.com> Co-authored-by: Andrew <dpieski@gmail.com> Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com> * fix build * fix duplicate editor * fixed docker mount problem * python 3.9 * added tasks for non-docker development * remove old scripts * dev updates * fixed no image upload option * get version from backend * final docs pass * .gitignore Co-authored-by: kentora <=> Co-authored-by: Hayden <hay-kot@pm.me> Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com> Co-authored-by: kentora <kentora@kentora.dk> Co-authored-by: David Young <davidy@funkypenguin.co.nz> Co-authored-by: Bastien <43323819+Batgame@users.noreply.github.com> Co-authored-by: sephrat <34862846+sephrat@users.noreply.github.com> Co-authored-by: Nick CJ <17556895+nickcj931@users.noreply.github.com> Co-authored-by: dekvall <dkvldev@gmail.com> Co-authored-by: wengtad <wengtad93@gmail.com> Co-authored-by: Alexei Pesic <pesic.alexei@gmail.com> Co-authored-by: Andrew <dpieski@gmail.com> Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com>
This commit is contained in:
Hayden
GitHub
parent
3ec0f2ec21
commit
b3573dc078
233 changed files with 11756 additions and 2491 deletions
|
|
@ -1,10 +1,68 @@
|
|||
# Release Notes
|
||||
|
||||
## v0.2.0 - Now with Test!
|
||||
This is, what I think, is a big release! Tons of new features and some great quality of life improvements with some additional features. You may find that I made promises to include some fixes/features in v0.2.0. The short of is I greatly underestimated the work needed to refactor the database to a usable state and integrate categories in a way that is useful for users. This shouldn't be taken as a sign that I'm dropping those feature requests or ignoring them. I felt it was better to push a release in the current state rather than drag on development to try and fulfil all of the promises I made.
|
||||
|
||||
!!! warning "Upgrade Process"
|
||||
Database Breaks! I have not yet implemented a database migration service. As such, upgrades cannot be done by simply pulling the image. You must first export your recipes, update your deployment, and then import your recipes. This pattern is likely to be how upgrades take place prior to v1.0. After v1.0 migrations will be done automatically.
|
||||
|
||||
### Bug Fixes
|
||||
- Remove ability to save recipe with no name
|
||||
- Fixed data validation error on missing parameters
|
||||
- Fixed failed database initialization at startup - Closes #98
|
||||
- Fixed misaligned text on various cards
|
||||
- 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**
|
||||
- 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
|
||||
- **Recipe Editor**
|
||||
- Ingredients are now sortable via drag-and-drop
|
||||
- Known categories now show up in the dropdown - Closes 83
|
||||
- Initial code for data validation to prevent errors
|
||||
- **Migrations**
|
||||
- Card based redesign
|
||||
- Upload from the UI
|
||||
- Unified Chowdown / Nextcloud import process. (Removed Git as a dependency)
|
||||
- **API**
|
||||
- Category and Tag endpoints added
|
||||
- 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.
|
||||
|
||||
- **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!
|
||||
- File/Folder restructuring
|
||||
- Added Prettier config
|
||||
- Fixed incorrect layout code
|
||||
- FastAPI Route tests for major operations - WIP (shallow testing)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
!!! error "Breaking Changes"
|
||||
- API endpoints have been refactored to adhear to a more consistent standard. This is a WIP and more changes are likely to occur.
|
||||
- Officially Dropped MongoDB Support
|
||||
- Database Breaks! We have not yet implemented a database migration service. As such, upgrades cannot be done by simply pulling the image. You must first export your recipes, update your deployment, and then import your recipes. This pattern is likely to be how upgrades take place prior to v1.0. After v1.0 migrations will be done automatically.
|
||||
|
||||
## 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
|
||||
|
|
@ -23,7 +81,7 @@
|
|||
- Major code refactoring to support new database layer
|
||||
- Global variable refactor
|
||||
|
||||
### Break Changes
|
||||
### Breaking Changes
|
||||
|
||||
- Internal docker port is now 80 instead of 9000. You MUST remap the internal port to connect to the UI.
|
||||
|
||||
|
|
@ -38,8 +96,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)
|
||||
|
|
@ -52,7 +110,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
|
||||
|
|
@ -63,8 +121,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.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ We use github to host code, to track issues and feature requests, as well as acc
|
|||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
|
||||
|
||||
1. Fork the repo and create your branch from `dev`.
|
||||
2. Read the page in in [dev/dev-notes.md](https://github.com/hay-kot/mealie/blob/0.1.0/dev/dev-notes.md) to get an idea on where the project is at.
|
||||
2. Read the page in in [dev/dev-notes.md](https://github.com/hay-kot/mealie/blob/master/dev/dev-notes.md) to get an idea on where the project is at.
|
||||
3. If you're interested on working on major changes please get in touch on discord and coordinate with other developers. No sense in doubling up on work if someones already on it.
|
||||
4. If you've changed APIs, update the documentation.
|
||||
5. Issue that pull request!
|
||||
|
|
|
|||
|
|
@ -14,7 +14,16 @@ There are VSCode tasks created in the .vscode folder. You can use these to quick
|
|||
|
||||
|
||||
## Without Docker
|
||||
?? TODO
|
||||
Prerequisites
|
||||
|
||||
- Python 3.8+
|
||||
- Poetry
|
||||
- Nodejs
|
||||
- npm
|
||||
|
||||
change directories into the mealie directory and run poetry install. cd into the frontend directory and run npm install. After installing dependencies, you can use vscode tasks to run the front and backend server. Use the command pallette to access the tasks.
|
||||
|
||||
Alternatively you can run `npm run serve` in the frontend directory and `python app.py` in the mealie directory to get everything up and running for development.
|
||||
|
||||
## Trouble Shooting
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
# Backup and Export
|
||||
|
||||
# Backup and Imports
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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 only SQLite is supported. Postrgres support is planned, however for most loads you may find SQLite performant enough.
|
||||
|
||||
|
||||
[Get Docker](https://docs.docker.com/get-docker/)
|
||||
|
|
@ -39,63 +39,15 @@ services:
|
|||
|
||||
```
|
||||
|
||||
|
||||
## Docker Compose with Mongo - DEPRECIATED
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml
|
||||
version: "3.1"
|
||||
services:
|
||||
mealie:
|
||||
container_name: mealie
|
||||
image: hkotel/mealie:latest
|
||||
restart: always
|
||||
ports:
|
||||
- 9000:80
|
||||
environment:
|
||||
db_username: root # Your Mongo DB Username - Please Change
|
||||
db_password: example # Your Mongo DB Password - Please Change
|
||||
db_host: mongo
|
||||
db_port: 27017 # The Default port for Mongo DB
|
||||
TZ: America/Anchorage
|
||||
volumes:
|
||||
- ./mealie/data/:/app/data/
|
||||
|
||||
mongo:
|
||||
image: mongo
|
||||
restart: always
|
||||
volumes:
|
||||
- ./mongo:/data/db
|
||||
environment:
|
||||
MONGO_INITDB_ROOT_USERNAME: root # Change!
|
||||
MONGO_INITDB_ROOT_PASSWORD: example # Change!
|
||||
|
||||
mongo-express: # Optional Mongo GUI
|
||||
image: mongo-express
|
||||
restart: always
|
||||
ports:
|
||||
- 9091:8081
|
||||
environment:
|
||||
ME_CONFIG_MONGODB_ADMINUSERNAME: root
|
||||
ME_CONFIG_MONGODB_ADMINPASSWORD: example
|
||||
|
||||
```
|
||||
|
||||
|
||||
## Env Variables
|
||||
|
||||
| Variables | default | description |
|
||||
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| db_type | sqlite | The database type to be used. Current Options 'sqlite' and 'mongo' |
|
||||
| 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 | UTC | 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.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Meal Planner
|
||||
|
||||
## Working with Meal Plans
|
||||
In Mealie you can create a mealplan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and seach through recipes to find your choice. After selecting a recipe for all meals save the plan. You can also randomly generate meal plans.
|
||||
In Mealie you can create a mealplan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and search through recipes to find your choice. After selecting a recipe for all meals save the plan. You can also randomly generate meal plans.
|
||||
|
||||
To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similiarly, to delete a mealplan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan.
|
||||
To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similarly, to delete a mealplan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan.
|
||||
|
||||
!!! warning
|
||||
In coming a future release recipes for meals will be restricted to specific categories.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# Migration
|
||||
|
||||
### Chowdown
|
||||
## Chowdown
|
||||
To migrate recipes from a Chowdown
|
||||
1. Download the code repository as a .zip file
|
||||
2. Upload the .zip file in the Chowdown section in Mealie
|
||||
3. Select import on the newly available migration.
|
||||
|
||||
In the Admin page on the in the Migration section you can provide a URL for a repo hosting a [Chowdown](https://github.com/clarklab/chowdown) repository and Mealie will pull the images and recipes from the instance and automatically import them into the database. Due to the nature of the yaml format you may have mixed results but you should get an error report of the recipes that had errors and will need to be manually added. Note that you can only import the repo as a whole. You cannot import individual recipes.
|
||||
|
||||
We'd like to support additional migration paths. [See open issues.](https://github.com/hay-kot/mealie/issues)
|
||||
|
||||
### Nextcloud Recipes
|
||||
Nextcloud recipes can be imported from either a zip file the contains the data stored in Nextcloud. The zip file can be uploaded from the frontend or placed in the data/migrations/Nextcloud directory. See the example folder structure below to ensure your recipes are able to be imported.
|
||||
## Nextcloud Recipes
|
||||
Nextcloud recipes can be imported from a zip file the contains the data stored in Nextcloud. The zip file can be uploaded from the frontend or placed in the data/migrations/nextcloud directory. See the example folder structure below to ensure your recipes are able to be imported.
|
||||
|
||||
```
|
||||
nextcloud_recipes.zip
|
||||
|
|
@ -21,6 +21,3 @@ nextcloud_recipes.zip
|
|||
└── recipe_3
|
||||
└── recipe.json
|
||||
```
|
||||
|
||||
**Currently Proposed Are:**
|
||||
- Open Eats
|
||||
|
|
@ -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.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! 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
BIN
docs/docs/gifs/backup-demo-v1.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 MiB |
BIN
docs/docs/gifs/homepage-settings-v1.gif
Normal file
BIN
docs/docs/gifs/homepage-settings-v1.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
BIN
docs/docs/gifs/meal-plan-demo-v2.gif
Normal file
BIN
docs/docs/gifs/meal-plan-demo-v2.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.4 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 MiB |
BIN
docs/docs/gifs/theme-demo-v2.gif
Normal file
BIN
docs/docs/gifs/theme-demo-v2.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.5 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.7 MiB |
|
|
@ -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
|
||||
|
|
@ -65,7 +73,6 @@ Mealie also provides an API for interactions from 3rd party applications. **Why
|
|||
* [Vue.js](https://vuejs.org/)
|
||||
* [Vuetify](https://vuetifyjs.com/en/)
|
||||
* [FastAPI](https://fastapi.tiangolo.com/)
|
||||
* [MongoDB](https://www.mongodb.com/)
|
||||
* [Docker](https://www.docker.com/)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,52 +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
|
||||
- [ ] Backup card redesign
|
||||
- [ ] Additional Backup / Import Features
|
||||
- [ ] Import Recipes Force/Rebase options
|
||||
- [ ] Upload .zip file
|
||||
- [ ] Improved Color Picker
|
||||
- [ ] Meal Plan redesign
|
||||
### Backend
|
||||
- [ ] PostgreSQL Support
|
||||
- [ ] Setup SQL Migrations
|
||||
|
||||
## Breaking Changes
|
||||
- Internal port 9000 changed to port 80 for better Traefik support
|
||||
- MongoDB support dropped
|
||||
## Code Chores
|
||||
- [ ] Remove MongoDB Interface Code
|
||||
- [ ] Dockerfile Trim
|
||||
See the [Github META issue for tracking the Road Map](https://github.com/hay-kot/mealie/issues/122)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue