Mirrors/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-11-01 10:43:25 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update dev docs, fix broken links, improve clarity of key points (#2354)

Browse Source 
* Dev docs: tests, postgres/psycog2

* Update pull request process.

* Add Food/Unit parsing instructions to the FAQ

* Update docker composes: mealie-data now local to docker-compose rather than hidden in docker volume dir! postgres points to 1.0.0b5

* sqlite docker-compose: mealie-data now local rather than hidden in docker volumes

* Merge Intro FAQ into main FAQ

* Progress on docs

* Add Advanced and v1b5 to docs index

* v1b5 changelog consistency with other changelogs

* Features: fix wrong link, name buttons for clarity

* Migration: link to github releases

* Updating: link to migration page, format docker cmds

* FAQ: update smart ingredient formatting

* Intro: fix typos

* API: update for newbie clarity

* Roadmap: update feature request & progress mechanism

* iOS shortcut: fix broken image links

* installation: add SMTP google app passwords

* Postgres: add header note on why.

* Update Groups doc per Discord discussion

* mealie-data back into docker default volume path
This commit is contained in:
Jacob Corn
2023-05-13 20:50:22 +02:00
committed by GitHub
parent 8e2d50054c
commit 27ebb4c462
16 changed files with 147 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/contributors/developers-guide/starting-dev-server.md
View File

@@ -15,7 +15,7 @@ Prerequisites
First ensure that docker is running. Then when you clone the repo and open with VS Code you should see a popup asking you to reopen the project inside a development container. Click yes and it will build the development container and run the setup required to run both the backend API and the frontend webserver. This also pre-configures pre-commit hooks to ensure that the code is up to date before committing.
Checkout the makefile for all of the available commands.
[Checkout the makefile reference](#make-file-reference) for all of the available commands.
!!! tip
For slow terminal checkout the solution in this [GitHub Issue](https://github.com/microsoft/vscode/issues/133215)
@@ -62,9 +62,13 @@ Once the prerequisites are installed you can cd into the project base directory
Before you start the server you MUST copy the `template.env` and `frontend/template.env` files to their respective locations with the name `.env` and `frontend/.env` respectively. The application will-not run without these files.
### Starting The Server
## Postgres
- Whether using a container or manual install, you need to set up your own postgres dev server. The database, username, password, etc should match the `POSTGRES_*` options located in the `.env` file.
- Install psycog2 with `poetry install -E pgsql` (in the main `mealie` directory, *not* `frontend`)
Once that is complete you're ready to start the servers. You'll need two shells open, One for the server and one for the frontend.
## Starting The Server
Now you're ready to start the servers. You'll need two shells open, One for the server and one for the frontend.
=== "Linux / macOS"