Contributions to ephios are welcome. If you want to see what we are currently up to, check the available issues.
If you have an idea for new feature you should start by deciding whether you want to write a plugin (see Developing plugins for ephios) or to contribute the feature to the ephios core code. A plugin is usually suitable if the feature is very specific to a small set of users (e.g. a specific signup process only used in your local organisation) or the feature is not related to the core tasks of ephios (e.g. a system for stock management). If all ephios users could profit from your feature, you should consider contributing it to the core code. Please start by describing your feature in a new issue in the GitHub repository to coordinate the extent with us. When working on existing issues, please assign yourself and create a pull request early on.
To set up a development version on your local machine, you need to execute the following steps:
Install external packages required for developing ephios
git(to check out the repository)
pythonversion 3.8 or higher including dev and virtualenv tooling
gettext(to compile translations, might also be named
Check out the repository and cd to it
Set up a virtualenv for the project activate it
Install poetry (if not already installed): Installation guide
Install dependencies with
Create env file with
cp .env.example .env
Migrate the database with
python manage.py migrate
Prepare files for the installation with
python manage.py build
Load data for testing with
python manage.py devdata
Start the development server with
python manage.py runserver
Open your web browser, visit
http://localhost:8000and log in with the default credentials (user
If those steps did not work for you, please contact us or open an issue in the GitHub repository.
The default development server is not suitable for production use. It is not secure and not performant. If you want to run ephios in production, please follow the deployment guide
We are enforcing a good code style for every pull request. To ensure that you only commit appropriate code, we recommend
installing a pre-commit hook with
pre-commit install. You can have a look at
.pre-commit-config.yaml to check
how this works. In short it executes the following steps before every commit:
autoflakewith a couple of flags to remove unused imports,
isort .to sort imports,
black .to format the code.
If you want to do that manually, run
pre-commit run --all-files.
Next to that, we also run
pylint ephios to check for semantic issues in the code.
python manage.py makemessages --all -d django python manage.py makemessages --all -d djangojs --ignore data --ignore docs
makemessages in the
current working directory. Therefore, we need to ignore the
data which contains static files from
3rd-party-packages already translated and the
a translation. To add them, do run
makemessages from the
data/public/static/ directory after running
collectstatic, but ignore all directories of 3rd-party-packages that are already translated, e.g.:
cd data/public/static/ python ../../../manage.py makemessages --all -d djangojs --ignore jsi18n --ignore admin --ignore CACHE --ignore recurrence --ignore select2
We tend to edit our .po files using weblate, but a local editor like poedit works as well.