iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,263 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
Igor Scheller 75ab9b1acf Clarified license definition as GPL 2.0 or later is supported 2020-05-01 19:40:22 +02:00
bin migration: Order by migrated and append not migrated 2019-07-21 20:54:17 +02:00
config Added /design path to show template elements 2020-04-25 17:04:57 +02:00
db DB/MySQL: Use utf8mb4 to support emojis 2020-04-25 16:54:30 +02:00
docker Added Schedule parsing and replaced old Fahrplan importer 2019-12-08 02:20:48 +01:00
includes Moved development error handler setup to ConfigureEnvironmentServiceProvider 2020-04-25 17:04:57 +02:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources Added /design path to show template elements 2020-04-25 17:04:57 +02:00
src Added /design path to show template elements 2020-04-25 17:04:57 +02:00
storage storage/: .gitignore fixups 2019-10-06 17:11:06 +02:00
tests Added /design path to show template elements 2020-04-25 17:04:57 +02:00
.babelrc Use core-js as polyfill to really support older browsers. 2019-07-26 12:40:21 +02:00
.browserslistrc Use core-js as polyfill to really support older browsers. 2019-07-26 12:40:21 +02:00
.editorconfig adding editorconfig to enforce PSR-2 2019-10-19 19:36:58 +02:00
.gitignore Adds a docker dev setup 2019-10-27 08:57:56 +01:00
.gitlab-ci.yml Formatting, syntax, typehint and namespace fixes, cleanups 2020-04-25 16:54:30 +02:00
.phpcs.xml Add phpcs config file 2019-11-13 01:07:02 +01:00
CONTRIBUTING.md Update docs 2020-01-20 02:23:16 +01:00
DEVELOPMENT.md Update docs 2020-01-20 02:23:16 +01:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md PHPUnit upgrade to 9.1, PHP upgrade to 7.3 2020-04-25 16:42:21 +02:00
composer.json Clarified license definition as GPL 2.0 or later is supported 2020-05-01 19:40:22 +02:00
package.json Clarified license definition as GPL 2.0 or later is supported 2020-05-01 19:40:22 +02:00
phpunit.xml PHPUnit upgrade to 9.1, PHP upgrade to 7.3 2020-04-25 16:42:21 +02:00
webpack.config.js add 36c3 theme 2019-11-23 18:39:09 +01:00
yarn.lock Update Frontend dependencies 2020-04-05 21:59:07 +02:00

README.md

pipeline status coverage report Codacy Badge GPL

Engelsystem

Please visit engelsystem.de for a feature list.

To report bugs use engelsystem/issues.

Since the Engelsystem is open source, you can help improving it. We really love to get pull requests containing fixes or improvements. Please read the CONTRIBUTING.md and DEVELOPMENT.md before you start.

Installation

The Engelsystem may be installed manually or by using the provided docker setup.

Requirements

  • PHP >= 7.3
    • Required modules:
      • dom
      • 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

Download

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

Configuration and Setup

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

The Engelsystem can now be used.

Session Settings

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

Docker

To build the es_nginx and the es_php_fpm containers:

cd docker
docker-compose build

or to build the containers separately

docker build -f docker/nginx/Dockerfile . -t es_nginx
docker build -f docker/Dockerfile . -t es_php_fpm

Import database

docker exec -it engelsystem_es_php_fpm_1 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