iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1,593 Commits 4 Branches 0 Tags 22 MiB
PHP 86.9%
Twig 8.4%
SCSS 3.3%
JavaScript 0.8%
HTML 0.3%
Other 0.3%
Go to file
msquare 5278be1f0f add link to public dashboard from shift view 2017-12-13 12:53:07 +01:00
config add dark theme for 34c3 2017-11-30 21:03:51 +01:00
db remove room number and visible flag, rename pentabarf to frab and introduce map/c3nav integration as well as markdown description for rooms 2017-12-10 15:02:37 +01:00
import camp 2011 export 2011-07-14 19:53:19 +02:00
includes add link to public dashboard from shift view 2017-12-13 12:53:07 +01:00
locale Rename 'supporter(s)' to 'Supporter(s)' 2017-12-02 16:31:37 +01:00
public improve public dashboard 2017-12-13 12:46:15 +01:00
src Refactored ExceptionHandler 2017-11-25 11:27:38 +01:00
templates add link to public dashboard from shift view 2017-12-13 12:53:07 +01:00
tests remove room number and visible flag, rename pentabarf to frab and introduce map/c3nav integration as well as markdown description for rooms 2017-12-10 15:02:37 +01:00
themes improve public dashboard 2017-12-13 12:46:15 +01:00
.gitignore Fixed exceptionHandler to catch PdoExceptions, formatting 2017-09-20 01:29:04 +02:00
.gitlab-ci.yml Added dokumentation for tests, gitlab and deployments 2017-12-04 13:26:36 +01:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Added dokumentation for tests, gitlab and deployments 2017-12-04 13:26:36 +01:00
composer.json Refactored ExceptionHandler 2017-11-25 11:27:38 +01:00
deploy.sh Added dokumentation for tests, gitlab and deployments 2017-12-04 13:26:36 +01:00
phpunit.xml Merge branch 'noc0lour:fix_setup_bugs', closes #335 2017-10-31 13:41:17 +01:00

README.md

Codacy Badge GPL

Engelsystem

Please visit https://engelsystem.de for a feature list.

To report bugs use engelsystem/issues

Installation

Requirements:

  • PHP >= 7.0.0
  • 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

  • Install project dependencies:

    composer install

    On production systems it is recommended to use

    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.

  • It must be created by the db/install.sql and db/update.sql files.

  • If necessary, create a config/config.php to override values from config/config.default.php.

  • In the browser, login with credentials admin:asdfasdf and change the password.

Engelsystem can now be used.

Session Settings:

  • Make sure the config allows for sessions.
  • Both Apache and Nginx allow for different VirtualHost configurations.

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

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!

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 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):

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 and PSR-4.