From ccec1fe63b66ce970c3ec7b8e0c3b15f92625767 Mon Sep 17 00:00:00 2001 From: Dorazil Date: Tue, 24 Oct 2023 17:55:53 +0200 Subject: [PATCH] Update docs --- .docs/instalace.md | 20 ++++++-------------- .docs/nastroje.md | 19 +++++++++++++++++-- .docs/tipy-pro-testovani.md | 11 ++++++++++- 3 files changed, 33 insertions(+), 17 deletions(-) diff --git a/.docs/instalace.md b/.docs/instalace.md index b1d2698f94..4caf5d4350 100644 --- a/.docs/instalace.md +++ b/.docs/instalace.md @@ -3,21 +3,21 @@ Aplikace vyžaduje: - PHP 8.1 - MySQL 8 -- Apache +- Nginx - Composer - Yarn ## Docker -Pro lokální vývoj je připraven Docker container a konfigurace pro **docker-compose**. +Pro lokální vývoj je připraven Docker container a konfigurace pro **docker compose**. +Všechny potřebné příkazy jsou definované v Make file ```bash -docker volume create --name hskauting_mysql -docker compose up -d # Spustí container v detached modu +make up # Spustí container v detached modu ``` V kontejneru je možné spustit bash pomocným skriptem: ```bash -docker/ssh +make enter ``` ## Nastavení hosts @@ -30,12 +30,4 @@ Stačí přidat tento řádek do souboru `/etc/hosts`: ``` ## Příprava projektu -V kontejneru stačí spustit příkaz `phing init`. - -**Poznámka**: Při commitování se automaticky opravuje coding standard v PHP - to však vyžaduje lokálně nainstalované PHP. -Pokud nemáte mimo kontejner instalované PHP alespoň ve verzi jako používá Hospodaření, -je možné automatickou opravu coding standardu vypnout nastavením proměnné `HUSKY_SKIP_INSTALL` na `true` při instalaci -`yarn` závislostí. Tedy např.: - -- `export HUSKY_SKIP_INSTALL=true; phing init` -- `HUSKY_SKIP_INSTALL=true yarn install` +Stačí spustit příkaz `make init`. \ No newline at end of file diff --git a/.docs/nastroje.md b/.docs/nastroje.md index 8a63bf4a40..03ac76c6b4 100644 --- a/.docs/nastroje.md +++ b/.docs/nastroje.md @@ -35,18 +35,27 @@ Pro testování používáme [Codeception](http://codeception.com/). Testy lze spustit příkazem v kontejneru: ```bash +phing tests # Jednotkové + Integrační testy + Akceptační testy phing tests-unit # Pouze jednotkové testy phing tests-integration # Pouze integrační testy -phing tests # Jednotkové + Integrační testy phing tests-acceptance # Akceptační testy ``` +nebo pomocí make přímo na hostujícím stroji: +```bash +make tests-all # Jednotkové + Integrační testy + Akceptační testy +make tests-unit # Pouze jednotkové testy +make tests-integration # Pouze integrační testy +make tests-acceptance # Akceptační testy +``` + + ## Coding standard Coding standard vychází z [Doctrine Coding Standardu](https://github.com/doctrine/coding-standard). Zda je projekt v souladu s CS lze ověřit pomocí příkazu v kontejneru: ```bash -phing coding-standard +phing coding-standard-ci ``` Automaticky lze nechat opravit pomocí: @@ -54,3 +63,9 @@ Automaticky lze nechat opravit pomocí: ```bash ./vendor/bin/phpcbf app ``` + +Nebo opět přímo z hostujícího stroje pomocí make: + +```bash +make coding-standard +``` \ No newline at end of file diff --git a/.docs/tipy-pro-testovani.md b/.docs/tipy-pro-testovani.md index 4339b74cc3..63eaab7f92 100644 --- a/.docs/tipy-pro-testovani.md +++ b/.docs/tipy-pro-testovani.md @@ -27,7 +27,7 @@ Jednotlivé testy: vendor/bin/codecept run ``` -Všechny daného typu: +Všechny daného typu lze spustit v kontejneru: ```bash phing tests phing tests-acceptance @@ -35,3 +35,12 @@ phing tests-integration phing tests-unit phing tests-with-coverage ``` + +Pomocí make na hostitelském stroji: +```bash +make tests-all +make tests-acceptance +make tests-integration +make tests-unit +make tests-with-coverage +```