diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 1f7e5e59..e0d252bc 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -42,7 +42,7 @@ The following instructions explain how to get, build and run the latest Engelsys To run the unit tests use ```bash vendor/bin/phpunit --testsuite Unit -``` +``` If a database is configured and the Engelsystem is allowed to mess around with some files, you can run feature tests. The tests can potentially delete some database entries, so they should never be run on a production system! @@ -50,7 +50,7 @@ The tests can potentially delete some database entries, so they should never be vendor/bin/phpunit --testsuite Feature # or for unit- and feature tests: vendor/bin/phpunit -``` +``` To run code coverage reports its highly recommended to use [`pcov`](https://github.com/krakjoe/pcov) or at least `phpdbg -qrr`(which has problems with switch case statements) as using Xdebug slows down execution. @@ -64,7 +64,7 @@ This Var Dump Server is especially useful for when you want to debug a request w To use simply call the method `dump` and pass the arguments in exactly the same way you would when using `var_dump`. -This will send the output to the Var Dump server which can be viewed in the terminal. +This will send the output to the Var Dump server which can be viewed in the terminal. This does however require that you start the var-dump-server otherwise the output will be printed in your browser You can also `dump` and `die` if you wish to not let your code continue any further by calling the `dd` method diff --git a/README.md b/README.md index 71e1b4a5..75ea01b4 100644 --- a/README.md +++ b/README.md @@ -33,16 +33,16 @@ The Engelsystem may be installed manually or by using the provided [docker setup * Extract the files to your webroot and continue with the directions for configurations and setup. ### Configuration and Setup - * The webserver must have write access to the ```storage``` directory and read access for all other directories - * The webserver must point to the ```public``` directory. - * The webserver must read the ```.htaccess``` file and ```mod_rewrite``` must be enabled + * The webserver must have write access to the `storage` directory and read access for all other directories + * The webserver must point to the `public` directory. + * The webserver must read the `.htaccess` file and `mod_rewrite` must be enabled * Recommended: Directory Listing should be disabled. * There must be a MySQL database set up with a user who has full rights to that database. - * If necessary, create a ```config/config.php``` to override values from ```config/config.default.php```. - * To edit values from the `footer_items`, `themes`, `locales`, `tshirt_sizes` or `headers` lists, directly modify the ```config/config.default.php``` file or rename it to ```config/config.php```. - * To import the database, the ```bin/migrate``` script has to be run. If you can't execute scripts, you can use the `initial-install.sql` file from the release zip. - * In the browser, login with credentials ```admin``` : ```asdfasdf``` and change the password. + * If necessary, create a `config/config.php` to override values from `config/config.default.php`. + * To edit values from the `footer_items`, `themes`, `locales`, `tshirt_sizes` or `headers` lists, directly modify the `config/config.default.php` file or rename it to `config/config.php`. + * To import the database, the `bin/migrate` script has to be run. If you can't execute scripts, you can use the `initial-install.sql` file from the release zip. + * In the browser, login with credentials `admin` : `asdfasdf` and change the password. The Engelsystem can now be used.