https://github.com/logantann/redbeansoup-v2

Rewrite of the redbeansoup-bot, also a discordeno bot framework
https://github.com/logantann/redbeansoup-v2

deno discord-bot discord-framework discordeno hacktoberfest hacktoberfest2022 kagerou-daze personal-project typescript

Last synced: about 1 month ago
JSON representation

Rewrite of the redbeansoup-bot, also a discordeno bot framework

• Host: GitHub
• URL: https://github.com/logantann/redbeansoup-v2
• Owner: LoganTann
• License: apache-2.0
• Created: 2022-06-15T00:13:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-19T21:05:23.000Z (over 2 years ago)
• Last Synced: 2024-05-02T02:20:17.410Z (9 months ago)
• Topics: deno, discord-bot, discord-framework, discordeno, hacktoberfest, hacktoberfest2022, kagerou-daze, personal-project, typescript
• Language: TypeScript
• Homepage:
• Size: 171 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Redbeansoup-soup

  

This is a rewriting of [redbeansoup-bot](https://github.com/LoganTann/redbeansoup-bot) with much more modules.

**Information** as I am the only one working in this project, there is no branch strategy. Dev code will be pushed as-is to the main branch. It is not recommanded to touch the code yet.

## Run the project in your hardware

See the dedicated file [doc: Run the project](documentation/run.md)

TL;DR : `deno run --import-map import_map.json --allow-all mod.ts` or `docker-compose up` after configuration.

## Content

* framework/ : See [doc: The framework](documentation/framework.md). Custom-made framework that runs the bot, built on top of discordeno

* src/ : See [doc: The bot](documentation/framework.md). Stores all bot commands and events

* web-back/ : See [doc: The dashboard](documentation/dashboard.md). Contains the back-end API

* web-front/ : See [doc: The dashboard](documentation/dashboard.md). Contains the front-end dashboard

* database/ : Creates the MySQL Client, and Models + Repositories of all required tables.

* documentation/ : markdown files

## Why a rewrite ?

Redbeansoup-bot had different flaws that had to be fixed in this rewrite : 

- Not typescript compliant (`--no-check` is required to run)

- Unmaintainable codebase (lack of organisation in files, codes...), and no code separation between framework (discordeno-related code) and the bot in itself. Difficulty to keep a same codebase compatible with both slash commands and prefix-based message commands.

- No docker support.

- Many bugs that get patched where they should not be, and use of some hacks to get typescript barely working.

## Can I use this code to create my own discordeno bot ?

Short answer : I don't recommend it. However, feel free to take inspiration (as long as it follows the apache2 license).

Long answser : This is a personal project, to experiment with deno and deepen my knowledge in software architecture w/ Typescript.  

Since I cannot warranty I will maintain it, i don't recommend including this project as a direct dependency. 

Moreover, it's currently in development (incomplete and subject to change). Instead :

- look at other frameworks, like [oasis](https://github.com/yuzudev/oasis), which is similar and much more stable.

- Use this repository as template (copy-paste or fork), instead of importing it from the GH URL