Wigan Homebrew Club Competition Entry
A project to facilitate anonymous entry into Wigan HBC competitions!
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Running The Project](#Running-the-project)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
This project is to allow homebrew club members to be given an identifying number/letter to put on their bottles for competitions. The goal is to allow all members to take part with no invigilator/organiser required.
### Built With
This project is built in python and deployed in docker.
* [Flask](http://flask.pocoo.org/)
* [Bootstrap](https://getbootstrap.com)
* [Docker](https://www.docker.com/)
## Getting Started
### Prerequisites
For development you need to have python3 installed along with pip. You can then set up a virtualenv and install requirements
```sh
pip install -r requirements.txt
```
### Running the project
A sample Dockerfile is included. Please note that you must supply an HBC_DB_PATH environmental variable. Below is a sample docker compose that can be used after you clone this repo.
```yaml
version: '3'
services:
wiganhomebrew:
container_name: wiganhomebrew
build:
restart: always
environment:
- HBC_DB_PATH=/data
volumes:
- sqlite-database-volume:/data
ports:
- 5000:5000
volumes:
sqlite-database-volume:
```
## Roadmap
See the [open issues](https://git.cusack.cloud/acid/wiganhbc-competition/issues) for a list of proposed features (and known issues).
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Sean Cusack - seancusack@gmail.com
Project Link: [https://git.cusack.cloud/acid/wiganhbc-competition](https://git.cusack.cloud/acid/wiganhbc-competition)