README.md

HbScorez

This is the repo for the web application HbScorez running hbscorez.de.
HbScorez processes handball game reports of diverse handball associations, districts, and leagues. It analyzes the player scores and displays the statistics and rankings.

Code of Conduct

See CODE_OF_CONDUCT.md

Feedback

The preferred way of giving feedback is via GitHub Issues.
You may use one of the Issue Templates which suggests useful context information depending on the type of feedback.

Contributing

See CONTRIBUTING.md

Acknowledgements

HbScorez is powered by Django

Running via Docker

docker run -p 8000:8000 djbrown/hbscorez:latest
App is reachable under 127.0.0.1:8000

Running natively

Requirements

1. Python 3.10
2. pipenv (pip install pipenv)
3. Java (>=1.6) for parsing game report PDFs

Installation

pipenv install
pipenv run ./src/manage.py migrate

Start Application

pipenv run ./src/manage.py runserver

Domain Model

Main Management Commands

• import_associations: Associations
• import_clubs: Clubs
• import_districts: Districts
• import_leagues: Seasons, Leagues, Teams
• import_games: Games, Sport Halls
• import_reports: Players, Scores

Execute commands via pipenv run ./src/manage.py <COMMAD> <OPTIONS>.
Prepend docker run djbrown/hbscorez:latest to execute inside Docker container.
Append -h to display command help.

License

The project is available as open source under the terms of the MIT License.