Metadata-Version: 2.1
Name: bundesliga-tippspiel
Version: 1.9.3
Summary: A Bundesliga Tippspiel Website
Home-page: https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel
Author: Hermann Krumrey
Author-email: hermann@krumreyh.com
License: GNU GPL3
Description: # Bundesliga Tippspiel
        
        |master|develop|
        |:----:|:-----:|
        |[![build status](https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel/badges/master/build.svg)](https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel/commits/master)|[![build status](https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel/badges/develop/build.svg)](https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel/commits/develop)|
        
        ![Logo](resources/logo/logo-readme.png)
        
        Bundesliga Tippspiel is a website using flask and various plugins that allows
        users to bet on Bundesliga matches and compete with one another.
        
        A live version of the page is available at
        [hk-tippspiel.com](https://hk-tippspiel.com).
        
        ## Documentation
        
        Documentation on the API can be found [here](doc/api/API.md).
        
        For general documentation visit the
        [progstats](https://progstats.namibsun.net/projects/bundesliga-tippspiel)
        page
        
        # Deployment notes:
        
        You can deploy the website using docker and docker-compose.
        To do this run the following commands:
        
            # Builds the docker image
            docker-compose build
            # Starts the container and the database container
            docker-compose up -d
            
        The .env file should contain the following variables:
        
        * FLASK_SECRET
        * DB_MODE
        * RECAPTCHA_SITE_KEY
        * RECAPTCHA_SECRET_KEY
        * SMTP_HOST
        * SMTP_PORT
        * SMTP_ADDRESS
        * SMTP_PASSWORD
        * TELEGRAM_API_KEY
        * POSTGRES_HOST
        * POSTGRES_PORT
        * POSTGRES_USER
        * POSTGRES_PASSWORD
        * POSTGRES_DB
        * DOMAIN_NAME
        * HTTP_PORT
        * BEHIND_PROXY
        * OPENLIGADB_SEASON
        
        # Backing up and restoring
        
        The project provides a backup and restore script in the [bin](bin) directory.
            
            # Backup
            bin/backup.sh backup.tar.gz
            # Restore
            bin/restore.sh backup.tar.gz
        
        ## Further Information
        
        * [Changelog](CHANGELOG)
        * [License (GPLv3)](LICENSE)
        * [Gitlab](https://gitlab.namibsun.net/namibsun/python/bundesliga-tippspiel)
        * [Github](https://github.com/namboy94/bundesliga-tippspiel)
        * [Progstats](https://progstats.namibsun.net/projects/bundesliga-tippspiel)
        * [PyPi](https://pypi.org/project/bundesliga-tippspiel)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
