documentation updates

This commit is contained in:
Hayden 2021-01-03 12:07:44 -09:00
parent b1390b5fec
commit a0acfdbc8f
3 changed files with 37 additions and 7 deletions

27
dev/dev-notes.md Normal file
View File

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

View File

@ -10,7 +10,9 @@ To deploy docker on your local network it is highly recommended to use docker to
## Env Variables
| 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 |

View File

@ -3,6 +3,7 @@
![Recipe Image](../images/{{ recipe.image }})
# {{ recipe.name }}
{{ recipe.description }}
## Ingredients
{% for ingredient in recipe.recipeIngredient %}