diff --git a/dev/README.md b/dev/README.md deleted file mode 100644 index 86040c3f49d8..000000000000 --- a/dev/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# Mealie Development Notes - -[toc] - -## Feature List (TODOs) - -### Frontend Tasks -- [x] Fix Menu Links -- [ ] 404 Page -- [x] Refactor API / Split Code -- [ ] Form Validation - - [x] Admin - - [x] Backups - - [x] Themes -- [ ] Recipe Viewer - - [ ] notes Hidden/Not Hidden - - [ ] Total Time Indicator - - [ ] BakeTime -- [x] Proper Response Handling - - [x] Recipe Created URL Feedback - - [x] Recipe Deleted - - [x] Backup Creation - - [x] Backup Deleted - - [x] Meal Plan - - [x] Empty Response Bug -- [x] Breakup Vue Componenets for Reusability - - [x] Meal Cards - - [x] Editor Button -- [x] Recipe Editor - - [x] New Recipe File Upload - - [x] Bulk Import for Ingredients / Instructions -- [x] Meal Plan - - [x] Creator - - [x] UI - - [x] Requests / Response - - [x] Timeline - - [x] View - - [x] Delete - - [x] Edit Existing - - [x] Random Meal Generator - - [x] Whats For Dinner Page - - [x] Current Meal Plan - - [ ] Include Lunch / Dinner / Breaksfast Categories Option -- [x] Admin Settings - - [x] Site Settings - - [x] Webhooks - - [x] Dark Mode - Cookies - - [x] Color Themes - Cookies - -### Backend Tasks -- [x] Proper Response Handling -- [ ] Backup Options - - [ ] Force Update - - [ ] Rebuild -- [ ] Meal Planner - - [x] Scheduler - - [x] Webhooks -- [ ] Recipe Data - - [ ] Better Scraper - - [ ] Image Minification - - [ ] Scraper Data Validation - - [ ] Category Management - - Lunch / Dinner / Breakfast <- Meal Generation - - Dessert / Side / Appetizer / Bread / Drinks / - - -## v1.0 Roadmad - -Frontend -- [ ] Login / Logout Navigation - - [ ] Initial Page - - [ ] Logic / Function Calls -Backend -- [ ] User Setup - - [ ] Authentication - - [ ] Default Admin/Superuser Account - - [ ] User Accounts - - [ ] Edit / Delete Lock diff --git a/docs/docs/1.2 - meal-planner.md b/docs/docs/1.2 - meal-planner.md index 10da8c001e17..fbc388801df7 100644 --- a/docs/docs/1.2 - meal-planner.md +++ b/docs/docs/1.2 - meal-planner.md @@ -1,7 +1,7 @@ # 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. +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. 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. diff --git a/docs/docs/1.3 - admin-panel.md b/docs/docs/1.3 - admin-panel.md index 6c18ad0e0123..e385f0f8dcde 100644 --- a/docs/docs/1.3 - admin-panel.md +++ b/docs/docs/1.3 - admin-panel.md @@ -1,10 +1,15 @@ -# Admin Panel +# Site Settings Panel !!! danger As this is still a **BETA** It is reccomended that you backup your data often and store in more than one place. Adhear to backup best practies with the [3-2-1 Backup Rule](https://en.wikipedia.org/wiki/Backup) -### Theme Settings -![](img/admin-theme.png) +## 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 random colors will first be generated, 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 avaiable to all users of the site. Seperate color themes can be set for both Light and Dark modes. + +![](gifs/theme-demo.gif) + +!!! note + Theme data is stored in cookies in the browser. Calling "Save Theme" will refresh the cookie with the selected theme as well save the theme to the database. ## Backup and Export @@ -17,10 +22,6 @@ To import a backup it must be in your backups folder. If it is in the backup fol ![](img/admin-backup.png) ## Meal Planner Webhooks -In the webhooks section you can find a list of all your endpoint URLs that are used as part of the meal planner +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 serverside. ![](img/admin-webhooks.png) - -## SFTP Settings - Target Release 1.0 - -## User Settings - Target Release 1.0 \ No newline at end of file diff --git a/docs/docs/2.0 - roadmap.md b/docs/docs/2.0 - roadmap.md new file mode 100644 index 000000000000..d41773ff8369 --- /dev/null +++ b/docs/docs/2.0 - roadmap.md @@ -0,0 +1,55 @@ +# Development Road Map + +Feature placement is not set in stone. This is much more of a guideline than anything else. + +## v1.0 Roadmad + +### Frontend +- [ ] Login / Logout Navigation + * [ ] Initial Page + * [ ] Logic / Function Calls + * [ ] Password Reset +### Backend +- [ ] User Setup + * [ ] Authentication + * [ ] Default Admin/Superuser Account + * [ ] Password Reset + * [ ] User Accounts + * [ ] Edit / Delete + +## v0.2.0 +### Front End + +- [ ] Recipe Editor + * [ ] Basic Form Validation +- [ ] Recipe Viewer + * [ ] Print Page View - Like King Arthur Website + * [ ] Notes Hidden/Not Hidden + * [ ] Total Time Indicator + * [ ] Bake Time + + +### Backend + +## v0.1.0 - Initial Release + +## Frontend Tasks +- [ ] General + * [ ] Recipe Category Handling +- [x] Meal Plan + * [ ] Include Lunch / Dinner / Breaksfast Categories Option + +### Backend Tasks +- [ ] Backup Options + * [ ] Force Update + * [ ] Rebuild +- [ ] Recipe Data + * [ ] Better Scraper + * [ ] Image Minification + * [ ] Scraper Data Validation +- [ ] Category Management + * [ ] Lunch / Dinner / Breakfast <- Meal Generation + * [ ] Dessert / Side / Appetizer / Bread / Drinks / + + + diff --git a/docs/docs/gifs/theme-demo.gif b/docs/docs/gifs/theme-demo.gif new file mode 100644 index 000000000000..b1fbb34a3a34 Binary files /dev/null and b/docs/docs/gifs/theme-demo.gif differ diff --git a/docs/docs/img/admin-theme.png b/docs/docs/img/admin-theme.png index 68dff1c4f76d..ac843547e755 100644 Binary files a/docs/docs/img/admin-theme.png and b/docs/docs/img/admin-theme.png differ diff --git a/docs/docs/img/admin-webhooks.png b/docs/docs/img/admin-webhooks.png index 3caf53dbdeed..f75f1cb7adf3 100644 Binary files a/docs/docs/img/admin-webhooks.png and b/docs/docs/img/admin-webhooks.png differ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c245df13147a..e0c22063985d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -6,8 +6,11 @@ theme: features: - navigation.instant markdown_extensions: + - def_list - pymdownx.highlight - pymdownx.superfences + - pymdownx.tasklist: + custom_checkbox: true - admonition extra_css: - stylesheets/custom.css diff --git a/frontend/src/components/AddRecipe.vue b/frontend/src/components/AddRecipe.vue index 2a28ea8c9bc0..301ccf9ca9fb 100644 --- a/frontend/src/components/AddRecipe.vue +++ b/frontend/src/components/AddRecipe.vue @@ -20,11 +20,11 @@ - + mdi-link diff --git a/frontend/src/components/Admin/Backup.vue b/frontend/src/components/Admin/Backup.vue index 881c785ba425..d6f3deb4b66a 100644 --- a/frontend/src/components/Admin/Backup.vue +++ b/frontend/src/components/Admin/Backup.vue @@ -1,6 +1,8 @@