diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 46 insertions, 6 deletions
@@ -5,19 +5,30 @@ Please visit https://engelsystem.de for a feature list. +To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsystem/issues) + ## Installation ### Requirements: * PHP >= 7.0.0 - * MySQL-Server >= 5.5.x + * MySQL-Server >= 5.5 or MariaDB-Server >= 5.5 * Webserver, i.e. lighttpd, nginx, or Apache ### Directions: * Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git` * Install [Composer](https://getcomposer.org/download/) - * Install project dependencies: `composer install` - * Webserver must have write access to the 'import' directory and read access for all other directories - * Webserver must point to the public directory. + * Install project dependencies: + ```bash + composer install + ``` + On production systems it is recommended to use + ```bash + composer install --no-dev + composerdump-autoload --optimize + ``` + to install the engelsystem + * The webserver must have write access to the 'import' directory and read access for all other directories + * The webserver must point to the public directory. * Recommended: Directory Listing should be disabled. * There must a be MySQL database created with a user who has full rights to that database. @@ -31,12 +42,41 @@ Engelsystem can now be used. * Make sure the config allows for sessions. * Both Apache and Nginx allow for different VirtualHost configurations. -Report Bugs: https://github.com/engelsystem/engelsystem/issues - ## Development Since the engelsystem is open source, you can help to improve the system. We really love to get pull requests containing fixes or implementations of our Github issues. Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite. +### Testing +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! +```bash +vendor/bin/phpunit --testsuite Feature +# or for unit- and feature tests: +vendor/bin/phpunit +``` + +### CI & Build Pipeline +The engelsystem can be tested and automatically deployed to a testing/staging/production environment. +This functionality requires a [GitLab](https://about.gitlab.com/) server with a running docker minion. + +To use the deployment features the following secret variables need to be defined (if undefined the step will be skipped): +```bash +SSH_PRIVATE_KEY # The ssh private key +STAGING_REMOTE # The staging server, e.g. user@remote.host +STAGING_REMOTE_PATH # The psth on the remote server, e.g. /var/www/engelsystem +PRODUCTION_REMOTE # Same as STAGING_REMOTE but for the production environment +PRODUCTION_REMOTE_PATH # Same as STAGING_REMOTE_PATH but for the production environment +``` + +#### deploy.sh +The `deploy.sh` script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh. + +For usage see `./deploy.sh -h` + ### Codestyle Please ensure that your pull requests follow [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/). |