radiorabe/catpage repository overview

⁠RaBe Cat Landing Page

Overengineered intranet landing page for Radio Bern RaBe⁠.

⁠Usage

1. Navigate to page
2. Find services
3. See cat
4. ???
5. PROFIT!!!

⁠Configuration

See python app/server.py --help for usage message and configuration info.

⁠Docker

docker run --rm -ti -p 5000:5000 radiorabe/catpage

Connect to localhost:5000⁠.

⁠Docker-compose

cp env.example .env
$EDITOR .env
docker-compose up -d

⁠Contributing

Contributions are welcome. Please keep in mind that everything here is completely overengineered.

⁠Running tests

You can run our tests with pytest. Please keep in mind that we expect to keep the coverage at 100% and that this is enforced by CI.

pytest --cov=app

⁠Formating code using a pre-commit hook

There is a pre-commit hook facility that tests code for formating and validity. You should install run this on your dev env to ensure that all the code is properly formatted and your changes will pass CI.

pip install pre-commit
pip install -r requirements-dev.txt -U
pre-commit install

⁠Commiting with commitizen

This project uses conventional-changelog⁠ style commit messages to help generate proper releases. Please check out the git-cz⁠ helper to help with formatting commit messages.

npm install -g commitizen cz-conventional-changelog

⁠Creating a Pull Request

Once your contribution is ready you can use the GitHub interface to create a pull request. Please try to keep your individual contribution self contained in a single squashed commit. This helps so that the maintainers can just hit "Squash and merge" instead of "Rebase and merge".

⁠Releasing an updated version

Anyone managing a release can run the semantic release tooling and publish a release. You should always remember to update your master branch and cleanup you local working copy.

git checkout master
git pull origin master
git stash

You can now run semantic-release.

semantic-release changelog
semantic-release version

⁠License

This application is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.

⁠Copyright

Copyright (c) 2019 Radio Bern RaBe⁠