aswi2020sebela-gitlab/README.md @ cecb4388

# ZČU Heatmap

- [**Nginx**](https://www.nginx.com/) - Server
- [**Symfony**](https://symfony.com/) - PHP framework
- [**MongoDB**](https://www.mongodb.com/) - Database

## 🔩 Development env

* Install **latest php**,  **[🐳 docker](https://www.docker.com/)**, **[📝 vscode](https://code.visualstudio.com/)** and **[🐍PyCharm](https://www.jetbrains.com/pycharm/)**
* Then run `./scripts/dev/build.sh` or `scripts/dev/build.bat` in the root of the project
* When you run `docker ps` you should see these containers: **heatmap_nginx**, **heatmap_php-fpm** and **heatmap_mongodb**
* Symfony project should be available on http://localhost:80
* ❗IMPORTANT❗make sure you are developing in vscode workspace for symfony
  * To get into workspace click on `symfony.code-workspace` and on bottom right <kbd>Open Workspace</kbd> 
### PHP Composer
* For composer commands `./scripts/composer.sh` and provide args
  * install `./scripts/composer.sh install`
  * require `./scripts/composer.sh require package_name`
### PHP Linter in vscode
* If you want check your code style is in the right format press <kbd>F1</kbd> choose `Tasks: Run Task` and `PHP Linter`
* If you want to format the current file just press <kbd>F1</kbd> choose 
`Tasks: Run Task` and `Format`
### PyCharm
* First you need to set python interpeter to the containers by **following these steps**
<div style="display: flex; flex-direction: row; justify-content: space-around;flex-wrap: wrap">
  <div style="height: 450px; display: flex; justify-content: space-between;flex-direction: column;">
  <img src="./guide/1.png" width="500px" style="display: block"/>
  <p style="background: red">A. Enter Settings (File/Preferences/Settings)</p>
  </div>
  <div style="height: 450px; display: flex; justify-content: space-between; flex-direction: column;">
  <img src="./guide/2.png" width="500px" height="360px" style="display: block"/>
  <p style="background: red">B. In the left panel choose <b>Docker</b> and in <b>Image Name</b> choose <b>heatmap_py-charm</b></p>
  </div>
  <div style="height: 450px; display: flex; justify-content: space-between;flex-direction: column;">
  <img src="./guide/3.png" width="500px" style="display: block"/>
  <p style="background: red">C. When setup is ok you will see all packages from requirements on this screen</b></p>
  </div>
</div>

* New dependencies put in **requirements.txt** and then run build `./scripts/dev/build.sh`

## 🚀 Production env
* To run production env on your local machine execute this `./scripts/build.sh`