https://github.com/jacobcoffee/byte

The Discord bot built for developers
https://github.com/jacobcoffee/byte

discord-bot discord-py github-api github-app htmx jinja2 litestar litestar-api nodejs oauth2 vite

Last synced: 10 days ago
JSON representation

The Discord bot built for developers

• Host: GitHub
• URL: https://github.com/jacobcoffee/byte
• Owner: JacobCoffee
• License: mit
• Created: 2023-09-17T23:37:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-11T21:59:37.000Z (25 days ago)
• Last Synced: 2024-10-14T09:54:19.274Z (23 days ago)
• Topics: discord-bot, discord-py, github-api, github-app, htmx, jinja2, litestar, litestar-api, nodejs, oauth2, vite
• Language: HTML
• Homepage: https://byte-bot.app/
• Size: 12 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst
  • Funding: FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Byte Bot

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

[![Tests And Linting](https://github.com/JacobCoffee/byte/actions/workflows/ci.yml/badge.svg)](https://github.com/JacobCoffee/byte/actions/workflows/ci.yml)

[![Documentation Building](https://github.com/JacobCoffee/byte/actions/workflows/docs.yml/badge.svg)](https://github.com/JacobCoffee/byte/actions/workflows/docs.yml)

> [!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][discordpy] library.

## Web

The web service is a [Litestar][litestar] application. It is utilizing [Jinja2][jinja] templating,

[TailwindCSS][tailwind], [DaisyUI][daisy], and [Feather icons][feather] 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][railway] for both the bot and the web service in production and testing.

## Development

You can use the provided [nixpack][nixpacks] [file](./nixpacks.toml), or set up your environment using [uv][uv].

## Contributing

All contributions are welcome! Please see [CONTRIBUTING](./CONTRIBUTING.rst) for more information.

### UI Examples

![Home](docs/images/home.png) ![Dark Home](docs/images/dark-home.png) ![Dashboard](docs/images/dashboard.png)

![API - Elements](docs/images/api-elements.png)

[litestar]: https://litestar.dev

[discordpy]: https://discordpy.readthedocs.io/en/stable/

[jinja]: https://jinja.palletsprojects.com/en/3.0.x/

[tailwind]: https://tailwindcss.com/

[daisy]: https://daisyui.com/

[feather]: https://feathericons.com/

[railway]: https://railway.app?referralCode=BMcs0x

[nixpacks]: https://nixpacks.com/docs/getting-started

[uv]: https://docs.astral.sh/uv/

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Alc-Alc
💻 🤔 🚇

      
allcontributors[bot]
📆

      
Jacob Coffee
📖 🚇 🎨 🤔

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.

Contributions of any kind welcome!