mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00

kzndotsh 101e5100e9 style(README.md): replace CRLF line endings with LF for better cross-platform compatibility

docs: add PROJECT_STRUCTURE.md to provide an overview of the project structure
feat(sync.py): enable administrator permissions check for the sync command to ensure security

2024-04-11 19:24:07 +00:00

2.6 KiB

Raw Blame History

Tux

A Discord bot for the All Things Linux Discord server

About

Tux is a Discord bot for the All Things Linux Discord server. It is designed to provide a variety of features to the server, including moderation, support, utility, and various fun commands. The bot is written in Python using the discord.py library.

Installation

Prerequisites

Python 3.11
Poetry

Steps

Clone the repository

git clone https://github.com/allthingslinux/tux && cd tux

Install the dependencies
```
poetry install
```
Activate the virtual environment
```
poetry shell
```
Install the pre-commit hooks
```
pre-commit install
```
Generate the prisma client
```
prisma generate
```
Copy the .env.example file to .env and fill in the required values
```
cp .env.example .env
```
Run {prefix}sync <server id> in the server to sync the slash command tree.
Review all useful CLI commands by visiting the useful CLI commands file.

License

This project is licensed under the terms of the The Unlicense license. See the LICENSE file for details.

2.6 KiB Raw Blame History

Tux