From 0e922903b1db4c0f9c106ffe3c8f1a5f3615a833 Mon Sep 17 00:00:00 2001 From: hay-kot Date: Sat, 20 Mar 2021 13:42:10 -0800 Subject: [PATCH] package/makefile docs update --- docs/docs/changelog/v0.4.0.md | 4 +++ .../developers-guide/starting-dev-server.md | 29 ++++++++++++------- docs/docs/getting-started/introduction.md | 8 ++--- 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/docs/docs/changelog/v0.4.0.md b/docs/docs/changelog/v0.4.0.md index eecb60d0c..8a2ce3d11 100644 --- a/docs/docs/changelog/v0.4.0.md +++ b/docs/docs/changelog/v0.4.0.md @@ -73,3 +73,7 @@ - Removed CDN dependencies - Database Model Refactoring - File/Folder Name Refactoring + - Development is now easier with a makefile! + - Mealie is now a proper package using poetry + - Test refactoring + - Test Coverage 75% diff --git a/docs/docs/contributors/developers-guide/starting-dev-server.md b/docs/docs/contributors/developers-guide/starting-dev-server.md index 4dd92f740..2ec547e57 100644 --- a/docs/docs/contributors/developers-guide/starting-dev-server.md +++ b/docs/docs/contributors/developers-guide/starting-dev-server.md @@ -3,27 +3,36 @@ 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. +Prerequisites -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. +- Docker +- docker-compose +You can easily start the development stack by running `make docker-dev` in the root of the project directory. This will run and build the docker-compose.dev.yml file. ## Without Docker Prerequisites -- Python 3.8+ +- Python 3.9+ - Poetry - Nodejs - npm -change directories into the mealie directory and run poetry install. cd into the frontend directory and run npm install. After installing dependencies, you can use vscode tasks to run the front and backend server. Use the command pallette to access the tasks. +Once the prerequisites are installed you can cd into the project base directory and run `make setup` to install the python and node dependencies. Once that is complete you can run `make backend` and `make vue` to start the backend and frontend servers. + +## Make File Reference +`make setup` installs python and node dependencies + +`make backend` Starts the backend server on port `9000` + +`make vue` Starts the frontend server on port `8080` + +`make mdocs` Starts the documentation server on port `8000` + +`make docker-dev` Builds docker-compose.dev.yml + +`make docker-prod` Builds docker-compose.yml to test for production -Alternatively you can run `npm run serve` in the frontend directory and `python app.py` in the mealie directory to get everything up and running for development. ## Trouble Shooting diff --git a/docs/docs/getting-started/introduction.md b/docs/docs/getting-started/introduction.md index 6ce3a9d61..2c26bf99f 100644 --- a/docs/docs/getting-started/introduction.md +++ b/docs/docs/getting-started/introduction.md @@ -12,15 +12,15 @@ Mealie is a self hosted recipe manager and meal planner with a RestAPI backend a ## Key Features -- 🔍 Powerful fuzzy search +- 🔍 Fuzzy search - 🏷️ Tag recipes with categories or tags to flexible sorting -- ⬇️ Import recipes from around the web by URL +- 🕸 Import recipes from around the web by URL - 📱 Beautiful Mobile Views - 📆 Create Meal Plans -- 🛒 Generate shopping lists from Meal Plans +- 🛒 Generate shopping lists - 🐳 Easy setup with Docker - 🎨 Customize your interface with color themes layouts -- ✉️ Export all your data in any format with Jinja2 Templates, with easy data restoration from the UI. +- 💾 Export all your data in any format with Jinja2 Templates, with easy data restoration from the user interface. - 🌍 localized in many languages - ➕ Plus tons more! - Flexible API