Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 871 Bytes

README.md

File metadata and controls

33 lines (25 loc) · 871 Bytes

MAX Vubot 🤖

A simple collaborative bot for the VUB's computer science master's discord.

Development 🛠

This project requires the poetry python package manager to be installed.

Once the repository is cloned, simply run

# To install dependencies and create a virtualenv
poetry install

# To activate virtualenv
poetry shell

# To run the project, simply type
python3 main.py

# to exit virtualenv
exit

You'll need a file named .env.json contianing the API key in order to run the bot. the file should look like :

{
    "API_KEY": "YOUR_API_KEY_HERE"
    "MOTD_CHANNEL": "The channel ID where the MOTD will be posted"
}

Contributing 🤝

Contributions are welcome! Feel free to open an issue or a pull request. Two templates are provided for both cases, make sure to follow them to make the contribution as complete as possible.