Requirements

• docker (at least 17.12.0+)
• docker-compose (at least 1.18.0)
• docker-hostmanager
• git

Docker name resolution

In order to access the application on your browser, your host machine must be able to resolve the host name of your container. We're using docker-etchosts to manage the hosts file entries. Check GitHub on how to set up our docker development environment.

Setup

• Copy the repository content (please don't fork it so that there is no link to forked repositories someone might look up the solution at)
• Start the containers docker-compose up
• Initialize the database docker-compose run django migrate
• Start frontend unit test docker-compose run angular npm test

API endpoints

The API provides GET, PUT, POST, PATCH, DELETE and OPTIONS to manage all user related needs

http://testcase.rh-dev.eu:8000/api/users to list and http://testcase.rh-dev.eu:8000/api/users/{id} to manage single users

JS frontend webserver

http://testcase.rh-dev.eu:8001

Frontend improvements

• Add pagination
• Create a mobile list user component
• Increase the coverage of unit tests
• Add End2End tests

Contribute

Requirements upgrades

Check for upgradeable packages by running

docker-compose up -d
docker-compose exec django pip-check

Making a new release

bumpversion is used to manage releases.

Add your changes to the CHANGELOG, run

docker-compose exec django bumpversion <major|minor|patch>

then push (including tags).