iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

documentation improvements 

remove trailing whitspaces
use single backticks
This commit is contained in:
Thomas Rupprecht 2022-11-28 19:25:42 +01:00 committed by Igor Scheller
parent d952dfe262
commit 47b80b504c
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
DEVELOPMENT.md
View File

@ -42,7 +42,7 @@ The following instructions explain how to get, build and run the latest Engelsys
To run the unit tests use To run the unit tests use
```bash ```bash
vendor/bin/phpunit --testsuite Unit 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. 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! 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 vendor/bin/phpunit --testsuite Feature
# or for unit- and feature tests: # or for unit- and feature tests:
vendor/bin/phpunit vendor/bin/phpunit
``` ```
To run code coverage reports its highly recommended to use [`pcov`](https://github.com/krakjoe/pcov) or 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. 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`. 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 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 You can also `dump` and `die` if you wish to not let your code continue any further by calling the `dd` method

14
README.md
View File

@ -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. * Extract the files to your webroot and continue with the directions for configurations and setup.
### Configuration 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 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 point to the `public` directory.
* The webserver must read the ```.htaccess``` file and ```mod_rewrite``` must be enabled * The webserver must read the `.htaccess` file and `mod_rewrite` must be enabled
* Recommended: Directory Listing should be disabled. * Recommended: Directory Listing should be disabled.
* There must be a MySQL database set up with a user who has full rights to that database. * 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```. * 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 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. * 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. * In the browser, login with credentials `admin` : `asdfasdf` and change the password.
The Engelsystem can now be used. The Engelsystem can now be used.