1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Tux is an all in one bot for the All Things Linux discord server.
Find a file
2024-03-28 04:16:41 -04:00
.github/workflows Update dependency-review.yml 2024-03-24 18:06:23 -04:00
config [Feat] Role Count command 2024-03-22 09:04:35 -04:00
docs [Docs] Update README.md 2024-03-28 04:16:41 -04:00
examples [Fix] Examples dir issue 2024-03-22 06:56:30 -04:00
prisma [Refactor] More major changes, replaced supabase client with prisma, added error handler concept 2024-03-28 01:20:05 -04:00
tests manually formatted with ruff 2023-12-29 10:55:10 -05:00
tmp [Refactor] More major changes, replaced supabase client with prisma, added error handler concept 2024-03-28 01:20:05 -04:00
tux [Refactor] More major changes, replaced supabase client with prisma, added error handler concept 2024-03-28 01:20:05 -04:00
.env.example [Feat][DB] Add supabase client and .env variables 2024-03-24 16:06:03 -04:00
.gitignore [Refactor] More major changes, replaced supabase client with prisma, added error handler concept 2024-03-28 01:20:05 -04:00
.mise.toml [Deps][CI/CD][Docs] Minor updates and fixes 2024-03-26 17:36:26 -04:00
.pre-commit-config.yaml [Refactor] Major changes to dir structure, temp removal of permissions, added loguru, added some async libs, improve types, clean pyproject config 2024-03-27 16:16:33 -04:00
docker-compose.yml [Fix][Reorg] Fixing some yml/toml files to add in support for poetry and added in an .env.example to show users what it should look like at this point in time 2023-12-27 18:29:04 -05:00
LICENSE.md [Fix] Embed.py and constants.py 2024-01-15 01:35:40 -05:00
poetry.lock [Refactor] Major changes to dir structure, temp removal of permissions, added loguru, added some async libs, improve types, clean pyproject config 2024-03-27 16:16:33 -04:00
pyproject.toml [Refactor] Major changes to dir structure, temp removal of permissions, added loguru, added some async libs, improve types, clean pyproject config 2024-03-27 16:16:33 -04:00
README.md [Docs] Update README.md 2024-03-28 04:16:41 -04:00

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

Steps

  1. Clone the repository

    git clone https://github.com/allthingslinux/tux && cd tux
    
  2. Install the dependencies

    poetry install
    
  3. Activate the virtual environment

    poetry shell
    
  4. Install the pre-commit hooks

    pre-commit install
    
  5. Copy the .env.example file to .env and fill in the required values

    cp .env.example .env
    
  6. 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.