Skip to content

Developer guides

Nikkel Mollenhauer edited this page Jul 23, 2022 · 7 revisions

The following collection of pages is aimed at developers that wish to continue expanding the recommerce simulation framework.

This page contains additional information about how to install dependencies needed for continuing the development of the recommerce framework as a developer.

The recommerce framework offers a locally installable package of the same name that can be installed using the pip package manager. This page will describe how the packaging works, and how to expand it.

Any questions regarding the process of adding a new varient of existing features, such as new marketplaces, vendors or tasks will be answered here.

The project features an extensive test suite using pytest, as well as linting and formatting guidelines enforced through pre-commit. This page offers an overview on how to work with these guidelines and tools.

For developers that wish to work with the remotely deployed version of the framework or want to deploy local docker containers, this page introduces how to do so.

This page offers a short introduction into our Github CI workflow and how to work with it.

In order to make expanding this wiki an easy task while maintaining its existing style and structure, we recommend reading this page first. The page will also give a short overview of how we document the code itself outside of this wiki.