github/mealie
1
0
Fork 0
mirror of https://github.com/hay-kot/mealie.git synced 2025-08-22 06:23:34 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 17

final docs pass

Browse source
This commit is contained in:
hay-kot 2021-02-08 09:08:14 -09:00
commit c7571051c7
2 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/contributors/developers-guide/starting-dev-server.md
View file

@ -14,7 +14,16 @@ There are VSCode tasks created in the .vscode folder. You can use these to quick
## Without Docker ## Without Docker
?? TODO Prerequisites
- Python 3.8+
- 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.
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 ## Trouble Shooting

4
docs/docs/getting-started/install.md
View file

@ -1,5 +1,5 @@
# Installation # 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 MongoDB and SQLite are supported. MongoDB support will be dropped in v0.2.0 so it is recommended to go with SQLite for new deployments. Postrgres support is planned, however for most loads you may find SQLite performant enough for most use cases. 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 only SQLite is supported. Postrgres support is planned, however for most loads you may find SQLite performant enough.
[Get Docker](https://docs.docker.com/get-docker/) [Get Docker](https://docs.docker.com/get-docker/)
@ -46,7 +46,7 @@ services:
| db_type | sqlite | The database type to be used. Current Options 'sqlite' | | db_type | sqlite | The database type to be used. Current Options 'sqlite' |
| mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. | | mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. |
| api_docs | True | Turns on/off access to the API documentation locally. | | api_docs | True | Turns on/off access to the API documentation locally. |
| TZ | | You should set your time zone accordingly so the date/time features work correctly | | TZ | UTC | You should set your time zone accordingly so the date/time features work correctly |
## Deployed as a Python Application ## Deployed as a Python Application