Installation & Setup

Installing MaMpf on your server or locally

• See the installation guide here. (Maybe outsource to the wiki?)
• See the testing guide here. (This one has not been checked for some time and might be outdated).

Setting up your workspace (as a dev team member)

You should have a working Ruby environment (recommended: rbenv, also install Bundler) & a Node.js environment (make sure you have yarn installed). Also install Docker Desktop as well as VSCode as editor (recommended).

• Clone the MaMpf Git repo locally.
• Install the recommended extensions in VSCode. Some settings are already pre-populated for you to ease onboarding and working with VSCode.
• Install the just command line runner to execute common tasks, e.g. run the tests, spin up docker containers etc. To do so, execute the commands from here (if you're on Ubuntu 24, you don't have to do this), then install just via sudo apt install just.
• Install yarn packages: yarn install
• Install Ruby gems. bundle install