Revize 20513e9f

Dokončení oborového projektu KIV/OPSWI

README.md

@@ -1 @@
-# ZČU Heatmap
+# Heatmap.ZČU
+App was created within the school project by ZČU students. The main goal of this project is to create a simple and generic tool for vizualization of heatmap like datasets. The first implementation can be seen at https://heatmap.zcu.cz.
+## Intro webpage
+<img src="./doc/images/website-intro.png" style="width: 600px; height: auto;">
 
-- [**Nginx**](https://www.nginx.com/) - Server
-- [**Symfony**](https://symfony.com/) - PHP framework
-- [**MongoDB**](https://www.mongodb.com/) - Database
+## Heatmap webpage
+<img src="./doc/images/website-heatmap.png" style="width: 600px; height: auto;">
+
+## Responsive
+<img src="./doc/images/website-responsive.png" style="width: 200px; height: auto;">
+
+<br><hr><br>
+
+## Technologies
+
+- [**Nginx**](https://www.nginx.com/) – Webserver
+- [**Symfony**](https://symfony.com/) – PHP framework
+- [**MongoDB**](https://www.mongodb.com/) – Database
+
+<br><hr><br>
 
 ## 🔩 Development env
 ### SW needed for development
 * **[🐳 docker](https://docs.docker.com/engine/install)**
 * **[🐳 docker-compose](https://docs.docker.com/compose/install/)**
 * **[📝 Visual Studio Code](https://code.visualstudio.com/Download)**
+<br><br>
+
 ### Development setup
 * First you need to **build** and **run** all needed containers
   * run either of these scripts inside the **root of the project**:
@@ -58 +75 @@
 * Set your breakpoints and hit <kbd>F5</kbd> or goto <kbd>Run >> Start debugging</kbd>
 * Working in both modules
 ## 🚀 Production env
-* To run production env on your local machine execute this `./scripts/build.sh`
+* To run production env on your local machine execute this `./scripts/build.sh`
+
+<br><hr><br>
+
+## Add new dataset to heatmap
+
+Follow these steps:
+
+1. Run script `modules/crawler/prepare_new_dataset.py` in directory `modules/crawler`.
+2. Fill items like `display-name`, `display-color`, `dataset-name`, `url`, `regex`, `update-period` within the YAML config file in directory `modules/crawler/DatasetConfigs`.
+3. Implement own dataset crawler in directory `modules/crawler/DatasetCrawler`.
+4. Implement own dataset processor in directory `modules/crawler/DatasetProcessing`.
+5. Run script `modules/crawler/force_update_dataset.py` and enter name of new dataset. After that all needed data are downloaded and processed.
+6. Fill coordinates to `devices` items in the YAML config file.
+7. After running `force_update_datasets.py` again, data will be loaded to database.
+
+<br><hr><br>
+
+## Auto updating datasets –⁠ Cron script
+
+File `modules/crawler/crone_update_script.py` performs update of all added datasets. Update period is defined in the YAML config file of each dataset (item `update-period`).
+
+Script `modules/crawler/crone_update_script.py` is executed by systems cron (`modules/crawler/crontab`) every day.
+
+<br><hr><br>
+
+## Customize appearance of the heatmap
+
+### SASS style file
+CSS color settings (backgrounds, controls, ...).
+
+`public/css/style.scss`
+
+### Heatmap locations list
+Locations with coordinates.
+
+`public/templates/heatmap-locations.html.twig`
+
+<img src="./doc/images/heatmap-locations-list.png" style="width: 250px; height: auto;">
+
+### Intro heatmap webpage
+`public/templates/index.html.twig`
+
+### Heatmap webpage
+`public/templates/heatmap.html.twig`