Merge branch 'dev' into master

.gitignore

@@ -3,14 +3,16 @@
 __pycache__/
 *.py[cod]
 *$py.class
-frontend/.env.development
+# frontend/.env.development
 docs/site/
 
 mealie/data/backups/*
 mealie/data/debug/*
 mealie/data/img/*
+!mealie/dist/*
 
 #Exception to keep folders
+!mealie/dist/.gitkeep
 !mealie/data/backups/.gitkeep
 !mealie/data/backups/dev_sample_data*
 !mealie/data/debug/.gitkeep
@@ -18,12 +20,12 @@ mealie/data/img/*
 
 .DS_Store
 node_modules
-/dist
+
 
 # local env files
 .env.local
 .env.*.local
-.env.development
+
 
 # Log files
 npm-debug.log*
@@ -48,7 +50,7 @@ pnpm-debug.log*
 env/
 build/
 develop-eggs/
-dist/
+
 downloads/
 eggs/
 .eggs/
@@ -143,5 +145,3 @@ ENV/
 
 # Node Modules
 node_modules/
-
-/*.env.development*

README.md

@@ -3,7 +3,6 @@
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![MIT License][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
 [![Docker Pulls][docker-pull]][docker-pull]
 
 <!-- PROJECT LOGO -->
@@ -27,7 +26,12 @@
     ·
     <a href="https://github.com/hay-kot/mealie/issues">Report Bug</a>
     ·
-    <a href="https://github.com/hay-kot/mealie/issues">Request Feature</a>
+    <a href="https://github.com/hay-kot/mealie/issues">
+    Request Feature
+    </a>    
+    ·
+    <a href="https://hub.docker.com/repository/docker/hkotel/mealies"> Docker Hub
+    </a>
   </p>
 </p>
 
@@ -39,7 +43,7 @@
 
 [![Product Name Screen Shot][product-screenshot]](https://example.com)
 
-**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 relavent 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 a secure API for interactions from 3rd party applications. **Why does my recipe manager need an API?** An API allows integration into applications like [Home Assistant]() 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. See the section on [Meal Plan hooks](#hooks) for more information. 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. 
 
@@ -56,7 +60,7 @@ Mealie also provides a secure API for interactions from 3rd party applications.
   - Add notes to recipes
 #### Meal Planner
   - Random Meal plan generation based off categories
-  - Expose notes in the API to allow external applications to access relavent information for meal plans
+  - Expose notes in the API to allow external applications to access relevant information for meal plans
 #### Database Import / Export
   - Easily Import / Export your recipes from the UI
   - Export recipes in into custom files using Jinja2 templates
@@ -73,7 +77,9 @@ Mealie also provides a secure API for interactions from 3rd party applications.
 <!-- CONTRIBUTING -->
 ## Contributing
 
-Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Especially test. Literally any tests. See the [Contributors Guide](https://hay-kot.github.io/mealie/contributors/developers-guide/code-contributions/) for help getting started.
+
+If you are not a coder, you can still contribute financially. financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development. 
 
 <a href="https://www.buymeacoffee.com/haykot" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
 

docs/docs/api/api-intro.md

@@ -0,0 +1,3 @@
+# API Introduction
+
+TODO

docs/docs/changelog.md

@@ -1,15 +1,15 @@
 # Release Notes
 
 ## v0.0.1 - Pre-release Patch
-General
+### General
-- Updated Favicon
+  - Updated Favicon
-- Renamed Frontend Window
+  - Renamed Frontend Window
-- Added Debug folder to dump scraper data prior to processing. 
+  - Added Debug folder to dump scraper data prior to processing. 
 
-Recipes
+### Recipes
-- Added user feedback on bad URL
+  - 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)
+  - 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
+  - Fixed spacing issue 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. 

docs/docs/contributors/developers-guide/code-contributions.md

@@ -1,26 +1,22 @@
 # Contributing to Mealie
-We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
-- Reporting a bug
+!!! Warning
-- Discussing the current state of the code
+    It should be known going into this that this is my first open source project, and my first public github repo I'm actively managing. If something does not make sense, or is not best practice. PLEASE feel free to reach out and let me know. I'm all about improving workflow and making it easier for contributors. 
-- Submitting a fix
-- Proposing new features
-- Becoming a maintainer
 
-[Remember to join the Discord and stay in touch with other developers working on the project](https://discord.gg/R6QDyJgbD2)! 
+[Please Join the Discord](https://discord.gg/R6QDyJgbD2). We are building a community of developers working on the project.
 
 ## We Develop with Github
 We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
 ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
-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:
+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 `master`.
+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.
-3. If you've changed APIs, update the documentation.
+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. Make sure your code lints.
+4. If you've changed APIs, update the documentation.
 5. Issue that pull request!
-6. If you make changes to the dev/0.1.0 branch reflect those changes in the dev/dev-notes.md to keep track of changes. 
+6. If you make changes to the dev branch reflect those changes in the dev/dev-notes.md to keep track of changes. Don't forget to add your name/handle/identifier! 
 
 ## Any contributions you make will be under the MIT Software License
 In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

docs/docs/contributors/developers-guide/general-guidelines.md

@@ -0,0 +1,3 @@
+# Guidelines
+
+TODO

docs/docs/contributors/developers-guide/starting-dev-server.md

@@ -0,0 +1,31 @@
+# Development: Getting Started
+
+After reading through the [Code Contributions Guide](https://hay-kot.github.io/mealie/contributors/developers-guide/code-contributions/) and forking the repo you can start working. This project is developed with :whale: docker and as such you will be greatly aided by using docker for development. It's not necessary but it is helpful.
+
+## With Docker
+`cd` into frontend directory and run `npm install` to install the node modules. 
+
+There are 2 scripts to help set up the docker containers in dev/scripts/. 
+
+`docker-compose.dev.sh` - Will spin up a docker development server
+`docker-compose.sh` - Will spin up a docker production server
+
+There are VSCode tasks created in the .vscode folder. You can use these to quickly execute the scripts above using the command palette.
+
+
+## Without Docker
+?? TODO
+
+## Trouble Shooting
+
+!!! Error "Symptom: Vue Development Server Wont Start"
+    **Error:** `TypeError: Cannot read property 'upgrade' of undefined`
+
+    **Solution:** You may be missing the `/frontend/.env.development.` The contents should be `VUE_APP_API_BASE_URL=http://127.0.0.1:9921`. This is a reference to proxy the the API requests from Vue to 127.0.0.1 at port 9921 where FastAPI should be running.
+
+!!! Error "Symptom: FastAPI Development Server Wont Start"
+    **Error:** `RuntimeError: Directory '/app/dist' does not exist`
+
+    **Solution:** Create an empty /mealie/dist directory. This directory is served as static content by FastAPI. It is provided during the build process and may be missing in development. 
+
+Run into another issue? [Ask for help on discord](https://discord.gg/R6QDyJgbD2)

docs/docs/contributors/non-coders.md

@@ -0,0 +1,15 @@
+# Non-Code Contributions
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+[Remember to join the Discord and stay in touch with other developers working on the project](https://discord.gg/R6QDyJgbD2)! 
+
+Additionally, you can buy me a coffee and support the project. When I get financial support it helps me know that there's real interest in the project and that it's worth the time to keep developing. 
+
+<a href="https://www.buymeacoffee.com/haykot" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

docs/docs/getting-started/backups-and-exports.md

@@ -1,19 +1,5 @@
-# Site Settings Panel
+# Backup and Export
-!!! danger
+![](../img/admin-backup.png)
-    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)
-
-
-## 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 available to all users of the site. Separate 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
-![](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. 
 
@@ -21,10 +7,10 @@ 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
+## 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. 
 
-#### Input
+### Input
 ```jinja2
 ![Recipe Image](../images/{{ recipe.image }})
 
@@ -52,7 +38,7 @@ Categories: {{ recipe.categories }}
 Original URL: {{ recipe.orgURL }}
 ```
 
-#### Output
+### Output
 ```markdown
 ![Recipe Image](../images/five-spice-popcorn-chicken.jpg)
 
@@ -90,14 +76,4 @@ Categories: []
 Original URL: https://www.bonappetit.com/recipe/five-spice-popcorn-chicken#intcid=_bon-appetit-recipe-bottom-recirc_3cad5ce9-734a-46f8-b503-78c33d2e7279_similar2-3
 ```
 
-If you decide you don't like mealie. This is a good way to export into a format that can be imported into another. 
+If you decide you don't like mealie. This is a good way to export into a format that can be imported into another. 
-
-
-## 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. 
-
-## Migration
-
-### Chowdown
-
-In the Admin page on the in the Migration section you can provide a URL for a repo hosting a Chowdown site 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. 

docs/docs/getting-started/install.md

@@ -1,4 +1,4 @@
-# Getting Started
+# 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 the only supported database is Mongo. Mealie is looking for contributors to support additional databases. 
 
 

docs/docs/getting-started/meal-planner.md

@@ -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.gif)

docs/docs/getting-started/migration-imports.md

@@ -0,0 +1,12 @@
+# Migration
+
+### Chowdown
+
+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)
+
+**Currently Proposed Are:**
+
+- NextCloud Recipes
+- Open Eats

docs/docs/getting-started/recipes.md

@@ -4,7 +4,7 @@
 Adding a recipe can be as easy as copying the recipe URL into mealie and letting the web scrapper try to pull down the information. Currently this scraper is implemented with [scrape-schema-recipe package](https://pypi.org/project/scrape-schema-recipe/). You may have mixed results on some websites, especially with blogs or non specific recipe websites. See the bulk import Option below for another a convenient way to add blog style recipes into Mealie.
 
 
-![](gifs/url-demo.gif)
+![](../gifs/url-demo.gif)
 
 
 ## Recipe Editor
@@ -12,12 +12,12 @@ Recipes can be edited and created via the UI. This is done with both a form base
 
 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. 
 
-![](gifs/editor-demo.gif)
+![](../gifs/editor-demo.gif)
 
 ## Bulk Import
 Mealie also supports bulk import of recipe instructions and ingredients. Select "Bulk Add" in the editor and paste in your plain text data to be parsed. Each line is treated as one entry and will be appended to the existing ingredients or instructions if they exist. Empty lines will be stripped from the text.
 
-![](gifs/bulk-add-demo.gif)
+![](../gifs/bulk-add-demo.gif)
 
 ## Schema 
 Recipes are stored in the json-like format in mongoDB and then sent and edited in json format on the frontend. Each recipes uses [Recipe Schema](https://schema.org/Recipe) as a general guide with some additional properties specific to Mealie.

docs/docs/getting-started/site-settings.md

@@ -0,0 +1,21 @@
+# Site Settings Panel
+!!! 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)
+
+
+## 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 available to all users of the site. Separate 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. 
+
+
+
+
+
+## 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. 
+
+

docs/docs/index.md

@@ -4,9 +4,18 @@
   <a href="https://github.com/hay-kot/mealie">
   </a>
   <p align="center">
+    A Place for All Your Recipes
+    <br />
+    <a href="https://github.com/hay-kot/mealie"><s>View Demo</s></a>
+    ·
     <a href="https://github.com/hay-kot/mealie/issues">Report Bug</a>
     ·
-    <a href="https://github.com/hay-kot/mealie/issues">Request Feature</a>
+    <a href="https://github.com/hay-kot/mealie/issues">
+    Request Feature
+    </a>    
+    ·
+    <a href="https://hub.docker.com/repository/docker/hkotel/mealies"> Docker Hub
+    </a>
   </p>
 </p>
 
@@ -62,16 +71,16 @@ Mealie also provides an API for interactions from 3rd party applications. **Why
 <!-- ROADMAP -->
 ## Road Map
 
-[See Roadmap](2.0 - roadmap)
+[See Roadmap](roadmap.md)
 
 
 
 <!-- CONTRIBUTING -->
 ## Contributing
 
-Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Especially test. Literally any tests.
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Especially test. Literally any tests. See the [Contributors Guide](https://hay-kot.github.io/mealie/contributors/developers-guide/code-contributions/) for help getting started.
 
-If you are not a coder, you can still contribute financially. financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for the project. 
+If you are not a coder, you can still contribute financially. financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development. 
 
 <a href="https://www.buymeacoffee.com/haykot" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
 

docs/mkdocs.yml

@@ -1,19 +1,46 @@
 site_name: Mealie Docs
+
 theme:
   favicon: img/favicon.png
   name: material
   icon:
     logo: material/silverware-variant
   features:
+    - navigation.expand
     - navigation.instant
+
 markdown_extensions:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
   - def_list
   - pymdownx.highlight
   - pymdownx.superfences
   - pymdownx.tasklist:
       custom_checkbox: true
   - admonition
+
 extra_css:
   - stylesheets/custom.css
 repo_url: https://github.com/hay-kot/mealie
 repo_name: hay-kot/mealie
+
+nav:
+  - About The Project: "index.md"
+  - Getting Started:
+      - Installation: "getting-started/install.md"
+      - Working With Recipes: "getting-started/recipes.md"
+      - Planning Meals: "getting-started/meal-planner.md"
+      - Site Settings: "getting-started/site-settings.md"
+      - Backups and Exports: "getting-started/backups-and-exports.md"
+      - Recipe Migration: "getting-started/migration-imports.md"
+  - API Reference:
+      - Swagger/OpenAPI: "api/api-intro.md"
+  - Contributors Guide:
+      - Non-Code: "contributors/non-coders.md"
+      - Developers Guide:
+          - Code Contributions: "contributors/developers-guide/code-contributions.md"
+          - Dev Getting Started: "contributors/developers-guide/starting-dev-server.md"
+          - Guidelines: "contributors/developers-guide/general-guidelines.md"
+  - Development Road Map: "roadmap.md"
+  - Change Log: "changelog.md"

frontend/.env.development

@@ -0,0 +1 @@
+VUE_APP_API_BASE_URL=http://10.10.10.12:9921

frontend/src/components/NewRecipe.vue

@@ -83,12 +83,19 @@ export default {
     onFileChange() {
       this.image = URL.createObjectURL(this.fileObject);
     },
+
     async createRecipe() {
       this.isLoading = true;
-      this.recipeDetails.image = this.fileObject.name;
+
+      if (this.fileObject) {
+        this.recipeDetails.image = this.fileObject.name;
+      } 
       let slug = await api.recipes.create(this.recipeDetails);
 
-      await api.recipes.updateImage(slug, this.fileObject);
+      if (this.fileObject) {
+        await api.recipes.updateImage(slug, this.fileObject);
+      }
+
       this.isLoading = false;
 
       this.$router.push(`/recipe/${slug}`);

frontend/src/components/UI/Confirmation.vue

@@ -0,0 +1,37 @@
+<template>
+  <v-dialog v-model="addRecipe" width="650" @click:outside="reset">
+    <v-card :loading="processing">
+      <v-card-title class="headline"> From URL </v-card-title>
+
+      <v-card-text> </v-card-text>
+
+      <v-card-actions>
+        <v-spacer></v-spacer>
+        <v-btn color="primary" text @click="createRecipe"> Exit </v-btn>
+        <v-btn color="primary" text @click="confirm"> Confirm </v-btn>
+      </v-card-actions>
+    </v-card>
+  </v-dialog>
+</template>
+
+<script>
+export default {
+  props: {
+    type: String,
+  },
+  data() {
+    return {};
+  },
+  methods: {
+    confirm() {
+      this.$emit("confirm");
+    },
+    exit() {
+      // do something? 
+    }
+  },
+};
+</script>
+
+<style>
+</style>