iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,771 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 f5a7598a45 tests: Removed exception handler registration because it has side effects 2023-01-24 20:49:31 +01:00
bin Convert class const's to enum's (#1050) 2023-01-24 19:23:57 +01:00
config Enable space after cast sniff and remove .git-blame-ignore-revs 2022-12-25 11:59:45 +01:00
db Migrate NeededAngelType model 2023-01-22 18:43:09 +01:00
docker Use PHP 8.2 for builds and fixed warning in email validation rule 2022-12-13 22:03:08 +01:00
includes replace sticky-headers javascript impl with css 2023-01-24 20:13:13 +01:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources replace sticky-headers javascript impl with css 2023-01-24 20:13:13 +01:00
src tests: Removed exception handler registration because it has side effects 2023-01-24 20:49:31 +01:00
storage storage/: .gitignore fixups 2019-10-06 17:11:06 +02:00
tests tests: Removed exception handler registration because it has side effects 2023-01-24 20:49:31 +01: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
.dockerignore Docker: Use single container for server 2022-04-29 20:22:08 +02:00
.editorconfig Add prettier 2022-12-23 02:20:43 +01:00
.eslintignore Add eslint 2022-11-27 16:31:32 +01:00
.eslintrc.json Remove function-paren-newline from ESLint, covered by prettier 2022-12-23 19:21:02 +01:00
.gitignore Add Possibility for Custom Translations: config/[locale]/custom.po 2023-01-17 19:22:59 +01:00
.gitlab-ci.yml Add pre-commit hook (#1071) 2023-01-24 14:26:10 +01:00
.phpcs.xml Enable space after cast sniff and remove .git-blame-ignore-revs 2022-12-25 11:59:45 +01:00
.prettierrc.json Add prettier 2022-12-23 02:20:43 +01:00
CONTRIBUTING.md Add prettier 2022-12-23 02:20:43 +01:00
DEVELOPMENT.md Add pre-commit hook (#1071) 2023-01-24 14:26:10 +01:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Bump minimum PHP version to 8.1 and update packages 2022-12-13 22:03:08 +01:00
composer.json Specify PHP version for PHPCS 2022-12-20 22:19:52 +01:00
composer.lock Update PHP dependencies (major version bumps) 2022-12-13 22:03:08 +01:00
deployment.tpl.yaml k8s: Use traefik as default ingress, added improved app url handling to support subpath deployments 2022-10-14 13:36:11 +02:00
package.json Add pre-commit hook (#1071) 2023-01-24 14:26:10 +01:00
phpstan.neon.dist Bump minimum PHP version to 8.1 and update packages 2022-12-13 22:03:08 +01:00
phpunit.xml Require @covers annotation for tests, increase workspace mem limit to 512M, improved coverage for db factories 2022-06-02 13:18:37 +02:00
webpack.config.js Use template literals instead of string concatenation (#1003) 2022-12-04 12:00:18 +01:00
yarn.lock Add pre-commit hook (#1071) 2023-01-24 14:26:10 +01:00

README.md

pipeline status coverage report 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 >= 8.1
    • 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 be a MySQL database set up 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 edit values from the footer_items, themes, locales, tshirt_sizes or headers lists, directly modify the config/config.default.php file or rename it to config/config.php.

  • To import the database, the bin/migrate script has to be run. If you can't execute scripts, you can use the initial-install.sql file from the release zip.

  • 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

Build

To build the es_server container:

cd docker
docker-compose build

or to build the container by its own:

docker build -f docker/Dockerfile . -t es_server

Run

Start the Engelsystem

cd docker
docker-compose up -d

Migrate

Import database changes to migrate it to the newest version

cd docker
docker-compose exec es_server 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

Documentation

More documentation can be found at: https://engelsystem.de/doc/