# hippo7

**Repository Path**: mirrors_magnusja/hippo7

## Basic Information

- **Project Name**: hippo7
- **Description**: Hippo7, modular vjing tool
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-21
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hippo7
<center>"Why is this called hippo7? I don't know, but hippos are cool."</center>

Hippo7 is a tool for visual live shows that can be synchronized to music.

The tool was build by [Benedikt Wiberg](https://github.com/qway/) and myself during an TUM Project at [Luminovo.ai](https://luminovo.ai).

![Some Class Images](/docs/docs/assets/images/hippo7_banner.png)

## Documentation

For a quickstart, installation help, examples and cool videos checkout the [documentaion](https://pkehnel.github.io/hippo7/).

## Development

### Pre-commit
Please make sure to have the pre-commit hooks installed.
Install [pre-commit](https://pre-commit.com/) and then run `pre-commit install` to register the hooks with git.

### Poetry
Use [poetry](https://poetry.eustace.io/) to manage your dependencies.
Please make sure it is installed for your current python version.
Then to install the defined dependencies for our project run:
```console
poetry install
```

### Makefile
We use [make](https://www.gnu.org/software/make/) to streamline our development workflow.
Run `make help` to see all available commands.

<!-- START makefile-doc -->
```
$ make help 
help                 Show this help message
build                Build the docker container and docs
check                Run all static checks (like pre-commit hooks)
docs                 Serve all docs
test                 Run all tests
test-docker          Run tests in the docker environment
dev-install          Install all the packages in the local python environment for development
run-server           Runs the render server
run-client           Runs the client to control the server 
```
<!-- END makefile-doc -->