Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/radiorabe/cat-page

overengineered intranet landing page with a cat
https://github.com/radiorabe/cat-page

radio-bern-rabe

Last synced: 5 days ago
JSON representation

overengineered intranet landing page with a cat

Awesome Lists containing this project

README

        

# RaBe Cat Landing Page

Overengineered intranet landing page for [Radio Bern RaBe](https://www.rabe.ch).

![Screenshot of page.](docs/screenshot.png)

## 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.

### Container

```bash
# using docker
docker run --rm -ti -p 8080:8080 ghcr.io/radiorabe/catpage
# or podman
podman run --rm -ti -p 8080:8080 ghcr.io/radiorabe/catpage
```

Connect to [localhost:8080](http://localhost:8080).

### Podman-compose

```bash
cp env.example .env
$EDITOR .env
podman-compose up -d
```

### Kubernetes

```bash
helm install catpage oci://ghcr.io/radiorabe/helm/catpage --version x.y.z
```

## Contributing

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

## Development

### Setup

```bash
python -mvenv venv
. ./venv/bin/activate

pipx install poetry

poetry install
```

### 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.

```bash
poetry run pytest
```

### 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.

```bash
pip install pre-commit
pre-commit install
```

### Commiting with commitizen

This project uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) style
commit messages to help generate proper releases. Please check out the [`git-cz`](https://github.com/commitizen/cz-cli)
helper to help with formatting commit messages.

```bash
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".

## 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](http://www.rabe.ch)