capt-assassins-bot

Introduction

This project is a Flask-based Python project that facilitates keeping track of an Assassins game.

The Python scripts assume a VPS with a domain name tagged to it. A Telegram bot should also be created, and configured to receive webhooks. More information on webhooks can be found here. The code can also probably be reconfigured for long-polling if need be.

Files

1. wsgi.py -- Provides an entry point for running the app via WSGI, which provides faster speeds than just using Flask's inbuilt development server. uWSGI is a good alternative.
2. assassins_web.py -- Called by wsgi.py, and is the main entry point for the app.
3. admin_endpoints.py provides a Web UI for the admins to access information and confirm keys.
4. telegram.py handles all Telegram-related APIs.
5. users_endpoints.py provides a Web UI for players to interact with.

Getting Started

1. You will need a Postgresql database set up. < Include the set up instructions here>

2. Install the required Python libraries:

   $ pip install flask requests psycopg2 uwsgi

3. Clone the directory:

   $ git clone https://github.com/tristonpang/capt-assassins-bot

4. cd in:

   $ cd capt-assassins-bot

5. Start up a uWSGI server:

   $ uwsgi --http :5000 --wsgi-file wsgi.py