Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.62 KB

README.md

File metadata and controls

37 lines (27 loc) · 2.62 KB
branch build status codecoverage
master CI master codecov master
production CI production codecov production

MÜSLI (Mathematisches Übungsgruppen und Scheinlisten Interface)

MÜSLI is a tool for managing tutorials an exercises used at the mathematics and computer science department of Universität Heidelberg. The production instance is available here.

Quick Setup:

All MÜSLI development is currently done using Docker and docker-compose. To fire up your own MÜSLI instance, simply execute the following:

git clone https://github.com/muesli-hd/muesli.git
cd muesli
docker-compose up

If this doesn't work, you could be missing docker or docker-compose. Please visit the docker and docker-compose installation guides and try the above commands again.

Contributing

Read more about contributing to this project in the CONTRIBUTING.md.

Changes

Read more about the changes in this project in the CHANGELOG.md.

Testing

MÜSLI has a test suite to catch bugs before going into production. If you want to execute them, simply use the included script:

./docker/run-tests.sh

It will fire up a docker-compose environment with all required services, run the tests and show you the output.