diff --git a/docs/development/docker.md b/docs/development/docker.md index a33aa5d6..aaa9f7cb 100644 --- a/docs/development/docker.md +++ b/docs/development/docker.md @@ -5,25 +5,25 @@ parent: Development has_children: false permalink: /development/docker description: >- -Setup docker and docker-compose for quick full stack mainsail development with simulavr without any real printer + Setup docker and docker-compose for quick full stack mainsail development with simulavr without any real printer --- # {{ page.title }} {{ page.description }} -# Setup +## Setup Install docker and docker-compose on your desired machine. -####Debian/Ubuntu +###Debian/Ubuntu ```shell sudo apt install docker docker-compose ``` -####Mac +###Mac https://docs.docker.com/docker-for-mac/install/ -####Windows +###Windows https://docs.docker.com/docker-for-windows/install/ -# Start +## Start 1. Look into the docker/config folder. Copy the ".example" without the "example ending". 2. Edit the configs to your likings. They are inital setup for a minimal setup environment with simulavr. 3. In the root directory of mainsail run @@ -31,8 +31,8 @@ https://docs.docker.com/docker-for-windows/install/ docker/run up ``` -# Development -####Commands +## Development +###Commands ```shell docker/run ps # showing running containers docker/run restart # restarting container @@ -41,6 +41,6 @@ docker/run restart # restarting container docker/run bash # spawning bash shell inside container ``` Restarting the api container will happen a lot, because simulavr WILL crash a lot! Timings within simulavr are not precise and klipper will bug alot about that. -# Todo +## Todo 1. The current implementation of simulavr/moonraker/klipper is kinda naiv, because docker wont run with systemd. I will fix that in later versions of the docker container, so you can restart specific containers and omit simulavr and bind a real connected printer for example. diff --git a/docs/development/standalone.md b/docs/development/standalone.md index 8be336e4..77f0431b 100644 --- a/docs/development/standalone.md +++ b/docs/development/standalone.md @@ -5,13 +5,13 @@ parent: Development has_children: false permalink: /development/standalone description: >- -Setup the project and start developing with your local printer(s) + Setup the project and start developing with your local printer(s) --- # {{ page.title }} {{ page.description }} -# Setup +## Setup Make a copy of the '.env.development.local.example' and omit the .example. In the new file edit it to refect your desired printer: ```dotenv @@ -24,7 +24,7 @@ cors_domains: ``` access the local running dev environment with `http://:`. -####Nodejs Environment >= v15.9.0 +###Nodejs Environment >= v15.9.0 Linux ```shell curl -sL https://deb.nodesource.com/setup_15.x | sudo -E bash - @@ -36,7 +36,7 @@ sudo apt-get install -y nodejs For other package-managers look here: https://nodejs.org/en/download/package-manager/ -# Start +## Start ```shell npm install # only once and if you updated/installed packages npm run serve # starting current build with hot module reloading