Go to file
Igor Scheller ea4c258e5c GitLab CI: Removed xdebug beta as it is not php7.3 compatible 2019-07-21 04:58:02 +02:00
bin Fixups and cleanup for GitLab CI 2018-09-03 22:09:07 +02:00
config all 3 color themes for camp and high contrast theme 2019-07-14 13:09:08 +02:00
contrib Fixed docker build 2019-06-03 20:33:09 +02:00
db migration: Add shiftentry_edit_angeltype_supporter permission to angels 2018-12-30 15:12:00 +01:00
import camp 2011 export 2011-07-14 19:53:19 +02:00
includes Added logout via AuthController 2019-06-12 10:24:02 +02:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources all 3 color themes for camp and high contrast theme 2019-07-14 13:09:08 +02:00
src Metrics: Added scrape memory usage 2019-07-08 00:22:16 +02:00
storage/cache Added caching for templating and routing 2018-11-24 16:30:36 +01:00
tests Basic coverage tests of logger classes for 100% unit tests coverage 2019-07-16 02:59:33 +02:00
.babelrc babelrc: Specify iOS target in lower case 2019-04-17 09:50:07 +02:00
.gitignore phpunit: Upgrade to version 8, fixed tests, formatting 2019-04-25 17:56:06 +02:00
.gitlab-ci.yml GitLab CI: Removed xdebug beta as it is not php7.3 compatible 2019-07-21 04:58:02 +02:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Add translation chapter 2019-05-05 15:50:23 +02:00
composer.json Upgraded external components 2019-06-03 21:36:58 +02:00
package.json upgrade chart.js lib and fix bargraph. fixes #511 2018-12-09 13:07:19 +01:00
phpunit.xml Merge branch 'noc0lour:fix_setup_bugs', closes #335 2017-10-31 13:41:17 +01:00
webpack.config.js all 3 color themes for camp and high contrast theme 2019-07-14 13:09:08 +02:00

README.md

pipeline status coverage report Codacy Badge GPL

Engelsystem

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

To report bugs use engelsystem/issues

Installation

Requirements

  • PHP >= 7.1
    • Required modules:
      • dom
      • gettext
      • json
      • mbstring
      • PDO
        • mysql
      • tokenizer
      • xml/libxml/SimpleXML
      • xmlwriter
  • MySQL-Server >= 5.7.8 or MariaDB-Server >= 10.2.2
  • Webserver, i.e. lighttpd, nginx, or Apache

Additional requirements if you want to build the project by yourself

  • Node >= 8 (Development/Building only)
  • Yarn (Development/Building only)
  • PHP Composer (Development/Building only)

This should be included in your node install

  • npm (Development/Building only)

Download

Stable

  • Go to the Releases page and download the latest stable release file.
  • Extract the files to your webroot and continue with the directions for configurations and setup.

Latest unstable

The following instructions explain how to get, build and run the latest engelsystem version directly from the git master branch (may be unstable!).

  • Clone the master branch: git clone https://github.com/engelsystem/engelsystem.git
  • Install Composer and Yarn (which requires Node.js)
  • Install project dependencies:
    composer install
    yarn
    
    On production systems it is recommended to use
    composer install --no-dev
    composer dump-autoload --optimize
    
    to install the engelsystem
  • Build the frontend assets
    yarn build
    

Configuration and Setup

  • The webserver must have write access to the import and storage directories 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 a be MySQL database created 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 remove values from the footer_items, available_themes, locales, tshirt_sizes or headers lists the config file has to be renamed.
  • To import the database the bin/migrate script has to be called. If you are not allowed to execute scripts, then execute the install-<version>.sql script. Download at Releases page.

  • 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 path 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

Docker container

To build the engelsystem and the engelsystem-nginx container:

cd contrib
docker-compose build

or to build the containers separately

docker build -f contrib/nginx/Dockerfile . -t engelsystem-nginx
docker build -f contrib/Dockerfile . -t engelsystem

Import database

docker exec -it engelsystem bin/migrate

Scripts

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.

For usage see ./bin/deploy.sh -h

bin/migrate

The bin/migrate script can be used to import and update the database of the engelsystem.

For more information on how to use it call ./bin/migrate help

Translation

We use gettext. You may use POEdit to extract new texts from the sourcecode. Please config POEdit to extract also the twig template files using the following settings: https://gist.github.com/jlambe/a868d9b63d70902a12254ce47069d0e6

Codestyle

Please ensure that your pull requests follow PSR-2 and PSR-4.