Skip to content

An Discord bot created by Programmers for Programmers.

Notifications You must be signed in to change notification settings

Ketshap/ketshap

Repository files navigation

hey there 👋

i'm ketshap and my purpose is to bake neat github features from their api to discord. you can count on me to bring mess onto your discord server because i will make all github embeds more detailed!

currently, the following features of github are supported:

  • repositories
  • pull requests
  • commits
  • issues
  • comments (issues, commits and pull requests)

and the following are planned to be added next:

  • review comments
  • users
  • gists

eventually, i plan on being able to automate transferring of large code texts that are automatically converted by discord into gist links to make the life of mobile users much easier.

you can add me by clicking here if you don't want to self-host the bot yourself.

protection 💭

to protect servers from being spammed, there are a few key limits placed into each embed or message:

  • maximum body: 200 characters
  • maximum embeds: 5 per message

to protect ourselves from being spammed, we also cache everything up to 10 minutes maximum. so please don't abuse our service because that's bad!

give me cookies 😍

ketshap is open for all sorts of contributions and can be self-hosted if u want with all the required external services located on the services folder and ketshap itself being swarm-ready. you can install ketshap and its required services by simply running:

docker build -t ketshap .
docker stack deploy --compose-file docker-compose.yml ketshap

you can also take it down by running:

docker stack rm ketshap

or take down a specific service of ketshap:

docker service rm ketshap_mongo

or update ketshap:

docker build -t ketshap .
docker stack deploy --compose-file docker-compose.yml ketshap

but before running all of those commands, you should configure the environment first... whoopsies. i should have said that first, but please configure the following environments if you plan on self-hosting:

  • .env

previews 🖼️

you can view actual screenshots of the embeds here.

repository

image

issue

image

issue comments

image

pull request

image

pull request comments

image

commit & commit comments

image

About

An Discord bot created by Programmers for Programmers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published