fsr5-fhaachen/DC-Universe

Discord-Bot, um mit den Massen der Erstis umgehen zu können

Fachschafts-Bot

Table of Contents

• About the project
• Getting Started
  • Installing
  • Run bot
  • bot.sh
• Versioning
• Built With
• Authors

About the project

Coming soon

Getting Started

Installing

Install all dependencies

apt install libffi-dev libnacl-dev python3-dev python3-pip python3-mysqldb tmux

Clone the repository and go to the cloned folder

git clone git@github.com:FHA-FB5/DC-Universe.git
cd DC-Universe

Install all required packages

pip3 install -r requirements.txt

Copy the example files

cp .env.example .env
cp alembic.example.ini alembic.ini

Edit the .env file (it is important that you add your bot token and database settings)

nano .env 

Edit the alembic.ini file (it is important that you add your database settings in line 38)

nano alembic.ini

Set up the database

alembic upgrade head

Run bot

You can start the bot manually with the following command

python3 run.py 

or if you are developr and want the bot to restart after each change:

./dev.sh

bot.sh

For using the bot.sh please look here in the Wiki.

Versioning

We use SemVer for versioning. For available versions, see the tags on this repository.

Built With

• discord.py - An API wrapper for Discord written in Python.

Authors

• Patrik Schmolke - Development - Rec0gnice
• Titus Kirch - Development - TitusKirch

See also the list of contributors who participated in this project.