diff --git a/dev/dev-notes.md b/dev/dev-notes.md new file mode 100644 index 000000000000..0becce626fce --- /dev/null +++ b/dev/dev-notes.md @@ -0,0 +1,27 @@ +# Working Todos + +Frontend +- [x] Catch 400 / bad response on create from URL +- [ ] Recipe Editor Data Validation CLient Side +- [x] Favicon +- [x] Rename Window + +Backend +- [x] Add Debug folder for writing the last pulled recipe data to. +- [x] Recipe Editor Data Validation Server Side +- [ ] Normalize Recipe data on scrape +- [ ] Support how to Sections +- [ ] Export Markdown on Auto backups + +# Draft Changelog +## v0.1.0 + +General +- Updated Favicon +- Renamed Frontend Window +- Added Debug folder to dump scraper data prior to processing. + +Recipes +- Added user feedback on bad URL. Now when +- 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 diff --git a/docs/docs/1.0 - getting-started.md b/docs/docs/1.0 - getting-started.md index 65254aa34165..56864cf4b7b2 100644 --- a/docs/docs/1.0 - getting-started.md +++ b/docs/docs/1.0 - getting-started.md @@ -9,13 +9,15 @@ To deploy docker on your local network it is highly recommended to use docker to ## Env Variables -| Variables | default | description | -| ----------- | ------- | ------------------------------------------------------------------------------------------------------------- | -| 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 | -| TZ | | You should set your time zone accordingly so the date/time features work correctly | +| Variables | default | description | +| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 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 | +| TZ | | You should set your time zone accordingly so the date/time features work correctly | ## Docker Compose diff --git a/mealie/data/templates/recipes.md b/mealie/data/templates/recipes.md index 7b2847176b96..4f05230f0dea 100644 --- a/mealie/data/templates/recipes.md +++ b/mealie/data/templates/recipes.md @@ -3,6 +3,7 @@ ![Recipe Image](../images/{{ recipe.image }}) # {{ recipe.name }} +{{ recipe.description }} ## Ingredients {% for ingredient in recipe.recipeIngredient %}