From d84399ebe09af3a561722a87cb454d109fd7b18d Mon Sep 17 00:00:00 2001 From: Hayden Date: Tue, 5 Jan 2021 08:49:10 -0900 Subject: [PATCH] more detailed docs --- README.md | 16 +++++++++++----- .../developers-guide/starting-dev-server.md | 4 +++- docs/docs/index.md | 15 ++++++++++++--- 3 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index eb4cf0d58f8e..42eb7bf13087 100644 --- a/README.md +++ b/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] @@ -27,7 +26,12 @@ · Report Bug · - Request Feature + + Request Feature + + · + Docker Hub +

@@ -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 -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. Buy Me A Coffee diff --git a/docs/docs/contributors/developers-guide/starting-dev-server.md b/docs/docs/contributors/developers-guide/starting-dev-server.md index 61b03005969b..a158076246a3 100644 --- a/docs/docs/contributors/developers-guide/starting-dev-server.md +++ b/docs/docs/contributors/developers-guide/starting-dev-server.md @@ -3,7 +3,9 @@ After reading through the [Code Contributions Guide](http://127.0.0.1:8000/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 -There are 2 scripts to help set up your development environment in dev/scripts/. +`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 diff --git a/docs/docs/index.md b/docs/docs/index.md index d43b2151180f..691d2ad901bd 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,9 +4,18 @@

+ A Place for All Your Recipes +
+ View Demo + · Report Bug · - Request Feature + + Request Feature + + · + Docker Hub +

@@ -69,9 +78,9 @@ Mealie also provides an API for interactions from 3rd party applications. **Why ## 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. Buy Me A Coffee