CreatBot/CreatBotMainsail
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix layout

Browse Source 
Signed-off-by: Stefan Dej <meteyou@gmail.com>
This commit is contained in:
Stefan Dej 2021-02-24 23:12:29 +01:00
parent fbdacef932
commit c2eeabe165
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/development/docker.md
View File

@ -5,25 +5,25 @@ parent: Development
has_children: false has_children: false
permalink: /development/docker permalink: /development/docker
description: >- 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.title }}
{{ page.description }} {{ page.description }}
# Setup ## Setup
Install docker and docker-compose on your desired machine. Install docker and docker-compose on your desired machine.
####Debian/Ubuntu ###Debian/Ubuntu
```shell ```shell
sudo apt install docker docker-compose sudo apt install docker docker-compose
``` ```
####Mac ###Mac
https://docs.docker.com/docker-for-mac/install/ https://docs.docker.com/docker-for-mac/install/
####Windows ###Windows
https://docs.docker.com/docker-for-windows/install/ https://docs.docker.com/docker-for-windows/install/
# Start ## Start
1. Look into the docker/config folder. Copy the ".example" without the "example ending". 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. 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 3. In the root directory of mainsail run
@ -31,8 +31,8 @@ https://docs.docker.com/docker-for-windows/install/
docker/run up docker/run up
``` ```
# Development ## Development
####Commands ###Commands
```shell ```shell
docker/run ps # showing running containers docker/run ps # showing running containers
docker/run restart <api/npm> # restarting container docker/run restart <api/npm> # restarting container
@ -41,6 +41,6 @@ docker/run restart <api/npm> # restarting container
docker/run bash <api/npm> # spawning bash shell inside container docker/run bash <api/npm> # 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. 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. 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. 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.

8
docs/development/standalone.md
View File

@ -5,13 +5,13 @@ parent: Development
has_children: false has_children: false
permalink: /development/standalone permalink: /development/standalone
description: >- 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.title }}
{{ page.description }} {{ page.description }}
# Setup ## Setup
Make a copy of the '.env.development.local.example' and omit the .example. Make a copy of the '.env.development.local.example' and omit the .example.
In the new file edit it to refect your desired printer: In the new file edit it to refect your desired printer:
```dotenv ```dotenv
@ -24,7 +24,7 @@ cors_domains:
``` ```
access the local running dev environment with `http://<your local ip>:<local port>`. access the local running dev environment with `http://<your local ip>:<local port>`.
####Nodejs Environment >= v15.9.0 ###Nodejs Environment >= v15.9.0
Linux Linux
```shell ```shell
curl -sL https://deb.nodesource.com/setup_15.x | sudo -E bash - 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: For other package-managers look here:
https://nodejs.org/en/download/package-manager/ https://nodejs.org/en/download/package-manager/
# Start ## Start
```shell ```shell
npm install # only once and if you updated/installed packages npm install # only once and if you updated/installed packages
npm run serve # starting current build with hot module reloading npm run serve # starting current build with hot module reloading