Prepare a local development environment

Install the required dependencies:

  • git

  • make

  • python3

  • nodejs

For example in Debian:

apt install git make python3 nodejs

Clone the repository:

git clone

Run the development server locally:

make app_run

Now you can visit the web interface of the development system in your browser: http://localhost:5000/

Update release notes

Notable changes (for users, moderators or admins) should be mentioned in the release notes.

A new release notes file should be created in docs/releases/, if the release notes for the upcoming version do not exist, yet. This new file should be referenced in the hidden section of docs/release/index.rst.

Translate content

Run make django-translate for collecting the translatable strings and for opening a translation editor. Run make app_compile_translations, if you just want to compile all translation catalogues.

The translation files (*.po) are stored below grouprise/locale. They can be edited manually with any suitable editor.

Profile specific operations

Sometimes it may be useful to analyze the runtime behavior of specific parts of the code. The management command profile_commands can be used for this purpose.

Example: export the profiling information of an execution of the update_search_index task:

printf '%s\n' \
        'from import Command as UpdateIndexCommand' \
        'UpdateIndexCommand().handle(remove=True)' \
    | grouprisectl profile_commands --output-file=/tmp/out.profile

The above usage of grouprisectl implies the execution within a grouprise deployment. For local development environments, you should use python3 instead.

The profiling export file can now be loaded into any Python profile visualization tool, e.g. RunSnakeRun.