Skip to content

Commit

Permalink
doc: better README
Browse files Browse the repository at this point in the history
  • Loading branch information
COil committed Mar 2, 2024
1 parent 9fd2d3d commit e242dc9
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,20 @@ or

Open [https://127.0.0.1:8000](https://127.0.0.1:8000) (considering your 8000 port is free).

Enjoy!
Enjoy! 🙂


## Requirements ⚙

* [PHP 8.2](https://www.php.net/releases/8.2/en.php) (also works with [PHP 8.3](https://github.com/strangebuzz/MicroSymfony/actions/runs/7687842034/job/20948348451))
* [PHP 8.2](https://www.php.net/releases/8.2/en.php) (also works with [PHP 8.3](https://github.com/strangebuzz/MicroSymfony/actions/workflows/symfony.yml))
* The [Symfony CLI](https://symfony.com/download)


## Optional requirements ⚙

* The [Xdebug](https://xdebug.org/) PHP extension if you want to run the code coverage report
* [Castor](https://github.com/jolicode/castor) task runner
* [Castor](https://github.com/jolicode/castor) task runner if you don't want to use
[Make](https://www.gnu.org/software/make/) and its [Makefile](https://github.com/strangebuzz/MicroSymfony/blob/main/Makefile)


## Stack 🔗
Expand Down Expand Up @@ -82,11 +83,11 @@ Enjoy!
* Functional test [example](https://github.com/strangebuzz/MicroSymfony/blob/main/tests/Functional/Controller/AppControllerTest.php)
* API test [example](https://github.com/strangebuzz/MicroSymfony/blob/main/tests/Api/Controller/SlugifyActionTest.php)
* E2E test [example](https://github.com/strangebuzz/MicroSymfony/blob/main/tests/E2E/Controller/AppControllerTest.php)
* Code coverage at 100%
* [Output on CI](https://github.com/strangebuzz/MicroSymfony/actions/runs/7186942462/job/19573439511)

* [Output on CI](https://github.com/strangebuzz/MicroSymfony/actions/runs/8070913583/job/22049355015)
* GitHub CI ([actions](https://github.com/strangebuzz/MicroSymfony/actions))
* [Tests job output](https://github.com/strangebuzz/MicroSymfony/actions/runs/7186942462/job/19573439511)
* [Lint job output](https://github.com/strangebuzz/MicroSymfony/actions/runs/7186942462/job/19573439221)
* [Tests job output](https://github.com/strangebuzz/MicroSymfony/actions/runs/8070913583/job/22049355015)
* [Lint job output](https://github.com/strangebuzz/MicroSymfony/actions/runs/8070913583/job/22049354786)
* Asset mapper+Stimulus ([documentation](https://symfony.com/doc/current/frontend/asset_mapper.html))
* Vanilla Js ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/assets/controllers/hello_controller.js)) ([demo](https://microsymfony.ovh/stimulus))
* Fetch on a JSON endpoint of the application ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/assets/controllers/api_controller.js)) ([demo](https://microsymfony.ovh/stimulus))
Expand All @@ -102,7 +103,7 @@ Enjoy!
* The [composer.json](https://github.com/strangebuzz/MicroSymfony/blob/main/composer.json)
file is normalized with [ergebnis/composer-normalize](https://github.com/ergebnis/composer-normalize)
* Use of the [composer bin plugin](https://github.com/bamarni/composer-bin-plugin)
to install and run `php-cs-fixer`.
to install and run [php-cs-fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)


## What it doesn't ship? ❌
Expand Down

0 comments on commit e242dc9

Please sign in to comment.