Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dorazil committed Oct 24, 2023
1 parent 8d960cc commit ccec1fe
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 17 deletions.
20 changes: 6 additions & 14 deletions .docs/instalace.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`.
19 changes: 17 additions & 2 deletions .docs/nastroje.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,37 @@ 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í:

```bash
./vendor/bin/phpcbf app
```

Nebo opět přímo z hostujícího stroje pomocí make:

```bash
make coding-standard
```
11 changes: 10 additions & 1 deletion .docs/tipy-pro-testovani.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,20 @@ Jednotlivé testy:
vendor/bin/codecept run <cesta k souboru>
```

Všechny daného typu:
Všechny daného typu lze spustit v kontejneru:
```bash
phing tests
phing tests-acceptance
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
```

0 comments on commit ccec1fe

Please sign in to comment.