Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bot-academia/gitty

A discord-bot for open source communities
https://github.com/bot-academia/gitty

discord discord-api discord-bot discord-js javascript nodejs

Last synced: 27 days ago
JSON representation

A discord-bot for open source communities

Awesome Lists containing this project

README

        

# Gitty
A discord-bot for open source communities


![Discord](https://img.shields.io/discord/722698945800831030?color=Discord&label=Discord&logo=Discord&logoColor=Discord&style=for-the-badge) ![GitHub pull requests](https://img.shields.io/github/issues-pr/bot-academia/gitty?style=for-the-badge) ![GitHub issues](https://img.shields.io/github/issues/bot-academia/gitty?color=red&style=for-the-badge) ![GitHub](https://img.shields.io/github/license/bot-academia/gitty?color=yellow&style=for-the-badge) ![GitHub top language](https://img.shields.io/github/languages/top/bot-academia/gitty?style=for-the-badge)

Gitty is a bot for [Discord](https://discord.com) that allows open source communities work with github with out leaving Discord . It integrates github api for giving the information you need to run your community.

# Introduction

Gitty is a open source discord bot made using discord.js a powerful javascript library build upon Node.JS. Gitty is made to help open source communities that are using Discord. As we all know that communication plays a major role in open source world and as these organizations are becoming larger everyday there should be a efficient method to resolve this issue. Gitty provides you enriching features to reduce communication gap in a community and streamline workflow.

## What's under the hood?

While building Gitty the main aim in our head was to bring github related info over to discord. For making this possible we used the Github api

```
https://api.github.com/orgs/Bot-Academia
```

The github API is extremly feature rich and provided us with everything we needed to make this bot possible.

## Why you need gitty?

Gitty is a github oriented bot, it has all the features that any org or personal user will require during their development process. We ourselves used it for the development of gitty website and documentation. The webhook Feature made it extremly easy for us to get notified with all the changes happening inside the repo.

# Add Gitty to your server

To add Gitty to your server visit Gitty's official [website](https://gitty.netlify.app).

Gitty can be added to any discord server directly by using the website link. When you land on the offical gitty website you will find a button "Add to discord".
simply click on it and you will be navigated to a discord page. You might have to login with your discord credentials on this page (if you are not logged in!), After loggin in succesfully, you will see a list of server that you own. Select the server from the dropdown and gitty will automatically land inside your discord server!

Now you can start playing around with gitty!

For any further in depth guidance to any of the command, kindly refer to our documentation.

# Usage

To know more about Gitty and how to use it read our official [guide](https://gitty-guide.netlify.app)