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

Readme: Bump versions and fix formatting 

* Bump required database versions for JSON support and better key handling
* Changed PHP version to use a supported one
* Fixed migration description
* Removed outdated hint for mail config
This commit is contained in:
Igor Scheller 2018-10-01 18:30:13 +02:00 committed by msquare
parent f35efe01e6
commit 957065bc09
2 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,16 +2,14 @@
[![GPL](https://img.shields.io/github/license/engelsystem/engelsystem.svg?maxAge=2592000)]() [![GPL](https://img.shields.io/github/license/engelsystem/engelsystem.svg?maxAge=2592000)]()
# Engelsystem # Engelsystem
Please visit https://engelsystem.de for a feature list. Please visit https://engelsystem.de for a feature list.
To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsystem/issues) To report bugs use [engelsystem/issues](https://github.com/engelsystem/engelsystem/issues)
## Installation ## Installation
### Requirements: ### Requirements:
* PHP >= 7.0 * PHP >= 7.1
* MySQL-Server >= 5.5 or MariaDB-Server >= 5.5 * MySQL-Server >= 5.7.8 or MariaDB-Server >= 10.2.2
* Webserver, i.e. lighttpd, nginx, or Apache * Webserver, i.e. lighttpd, nginx, or Apache
* Node >= 8 (Development/Building only) * Node >= 8 (Development/Building only)
* Yarn (Development/Building only) * Yarn (Development/Building only)
@ -62,7 +60,8 @@ To run the unit tests use
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. The tests can potentially delete some database entries, so they should never be run on a production system! 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 ```bash
vendor/bin/phpunit --testsuite Feature vendor/bin/phpunit --testsuite Feature
# or for unit- and feature tests: # or for unit- and feature tests:
@ -97,12 +96,9 @@ docker build -f contrib/Dockerfile . -t engelsystem
Import database Import database
```bash ```bash
docker exec -i db_container mysql -u engelsystem -pengelsystem engelsystem < db/install.sql docker exec -it engelsystem bin/migrate
docker exec -i db_container mysql -u engelsystem -pengelsystem engelsystem < db/update.sql
``` ```
To be able to send mails a relay is needed. Set `SMTPHOST=[mail container]` to configure it.
#### Scripts #### Scripts
##### bin/deploy.sh ##### bin/deploy.sh
The `bin/deploy.sh` script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh. The `bin/deploy.sh` script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh.

2
composer.json
View File

@ -14,7 +14,7 @@
} }
], ],
"require": { "require": {
"php": ">=7.0.0", "php": ">=7.1.0",
"ext-gettext": "*", "ext-gettext": "*",
"ext-json": "*", "ext-json": "*",
"ext-libxml": "*", "ext-libxml": "*",