Revize 6f6156eb

Feature #7743 Setup for development environment

README.md

@@ -1 +1 @@
 # ZČU Heatmap
 
 - [**Nginx**](https://www.nginx.com/) - Server
-- [**Symfon**](https://symfony.com/) - PHP framework
+- [**Symfony**](https://symfony.com/) - PHP framework
 - [**MongoDB**](https://www.mongodb.com/) - Database
 
-## 🚀 Installation
+## 🔩 Devlopment env
 
-* Install 🐳 **[docker](https://www.docker.com/)**
-* Then run `./build.sh` or `build.bat` in the root of the project
+* Install **[🐳 docker](https://www.docker.com/)** and **[📝 vscode](https://code.visualstudio.com/)**
+* 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 install execute `./composer-install.sh` or `composer-install.bat`
+* For composer commmands `./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 you use <kbd>CTRL+Shift+I</kbd> or <kbd>🖱️ RightClick</kbd> + `Format Document`
+## 🚀 Production env
+* To run production env on your local machine execute this `./scripts/build.sh`