Commit c61dfc3e authored by Thomas Eimers's avatar Thomas Eimers
Browse files

Update Documentation, cleanup unneeded code

parent 126dfe17
Pipeline #91223915 failed with stages
in 19 minutes and 41 seconds
......@@ -5,7 +5,8 @@
![Applicatiuon Preview](https://www.notdefine.de/projects/heizungssteuerung-mit-raspberry-pi/sensor-list.jpeg "Show all configured sensors")
![Applicatiuon Preview](https://www.notdefine.de/projects/heizungssteuerung-mit-raspberry-pi/temp.svg "Show temperature graph")
![System Structure](https://notdefine.de/projects/heizungssteuerung-mit-raspberry-pi/umweltdiagramm.png "Syste structure")
![System Structure](https://notdefine.de/projects/heizungssteuerung-mit-raspberry-pi/umweltdiagramm.png "System structure")
![Service Structure](https://notdefine.de/projects/heizungssteuerung-mit-raspberry-pi/ServiceStructure.png "Service structure")
## Sytem Requirements
......@@ -25,13 +26,13 @@
It is needed to setup the database on the system first. (see [Setup.md](SETUP.md))
```sh
```bash
cd backend
composer doctrine-init
```
### Run backend application for local testing
```sh
```bash
cd backend
composer up
composer run serve
......@@ -45,7 +46,7 @@ composer run serve
If you call the frontend without the 'api' get parameter for the backend API it would show some dummy data.
```sh
```bash
cd frontend
npm install
./node_modules/@angular/cli/bin/ng serve
......@@ -61,7 +62,7 @@ http://localhost:4200/?api=http:%2F%2localhost:8081
### Test Backend Application
```sh
```bash
cd backend
php composer.phar run lint
php composer.phar run tests
......@@ -70,14 +71,14 @@ php composer.phar run phpcs (phpcs-fix for auto correction errors)
### Generate static API documentation via swagger
```sh
```bash
cd backend
php composer.phar add-swagger-uiswagger
```
### Edit Swagger configuration file
```sh
```bash
docker run -p 80:8080 swaggerapi/swagger-editor
```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment