Skip to content
This repository has been archived by the owner on May 9, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (27 loc) · 1.68 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.68 KB

Madeline : The Discord Bot (Selfhosted Edition)

Build Production CI pre-commit checks
Build Production pre-commit

Madeline : The Discord bot (selfhost edition) with minimal features to query your favorite server, made with NAFF. Visit the official guide to get started.

Running the Application

There are multiple ways to launch the application.

Python

To start the bot with python, you first need to install the required packages with pip install -r requirements.txt

Then, run:

  1. python main.py

Docker-Compose

You can use the pre-made docker-compose by running:

  1. docker-compose up

Docker

For most users, the use of docker-compose is highly recommended.

Nevertheless, you can import the pre-made Dockerfile into your own docker-compose or run it manually by with:

  1. docker build -t samp-query-bot .
  2. docker run -it samp-query-bot

Note: Make sure that you created a volume so that you local ./logs folder gets populated.

Additional Information

Additionally, this comes with a pre-made pre-commit config to keep your code clean.

It is recommended that you set this up by running:

  1. pip install pre-commit
  2. pre-commit install