Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 4.4 KB

README.md

File metadata and controls

89 lines (63 loc) · 4.4 KB

Byte Bot

All Contributors

Tests And Linting Documentation Building

Warning

This repository holds very broken code. It is not recommended to use this code in any way. It is currently being used to learn the creation of a Discord bot, used by developers to enhance their community/guild experience with features like

  • GitHub integration
  • Upload Threads/Forum Posts to GitHub discussions
  • Sync commit contributions for a repo or organization to a Discord role (Commit Club type gamification)
  • Create GitHub issue from thread, forum post, or comment

and whatever else is found to be useful.

All of this may go down in flames, though... so... yeah - good luck 😅

Bot

The Discord bot is built on the Discord.py v2 library.

Web

The web service is a Litestar application. It is utilizing Jinja2 templating, TailwindCSS, DaisyUI, and Feather icons for the front end, and the backend is using the Litestar-provided utilities for routing, middleware, and more.

Deployment

Byte is currently deployed to Railway for both the bot and the web service in production and testing.

Development

You can use the provided nixpack file, or set up your environment using uv.

Contributing

All contributions are welcome! Please see CONTRIBUTING for more information.

### UI Examples

Home Dark Home Dashboard API - Elements

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alc-Alc
Alc-Alc

💻 🤔 🚇
allcontributors[bot]
allcontributors[bot]

📆
Jacob Coffee
Jacob Coffee

📖 🚇 🎨 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!