Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ankushkun/komi-bot

Source Code for our bot that manages time and other functions of the server <3
https://github.com/ankushkun/komi-bot

discord-bot hacktoberfest

Last synced: 6 days ago
JSON representation

Source Code for our bot that manages time and other functions of the server <3

Host: GitHub
URL: https://github.com/ankushkun/komi-bot
Owner: ankushKun
License: gpl-3.0
Created: 2021-06-20T05:36:03.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-08-14T04:36:27.000Z (over 3 years ago)
Last Synced: 2024-04-14T01:55:30.482Z (9 months ago)
Topics: discord-bot, hacktoberfest
Language: Python
Homepage:
Size: 1.37 MB
Stars: 7
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Komi San wants you to study

This repo contains the source code for our bot that manages time and other functions of the server <3

## Features

- Your study time in VC gets tracked
- Daily, Weekly and Monthly leaderboards
- Healthy Study environment
- Seperate section for extracurricular activities
- Accountability features
- Private study rooms
- Study plylists and Study material shared by our members

[![Discord](https://img.shields.io/discord/843086218120134666?label=Join%20us&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/bcx7vwFXJG)

## How to run the bot locally

### Clone the repo

```shell
git clone https://github.com/KomiStudy/Komi-Bot.git
cd Komi-Bot
```

### Install the requirements

```shell
pip3 install -r requirements.txt
```

### Add API keys to .env and firabase.json

Visit the discord developer portal and copy the bot token of your bot and paste it in `env.example` without any " " then rename the file to `.env`

Visit `console.firebase.google.com` and create a new project

Setup realtime database and then add a web app for the project. This should provide you a firebaseConfig script, you just need the API keys, copy them and paste them in `firebase.json`

Lastly open `config.json` and enable `USE_FIREBASE_JSON` from 0 to 1, this will make sure the code uses the json file to connect to the database insteal of the env file

### Run the bot

```shell
python3 run_bot.py
```

## Contribute to the project

Feel free to fork the repo and add more features or enhance the codes.\
Make sure you are in the server and have consulted the staff before live testing your bot or making any changes.
We will be more than happy if you support us by contributing :s)