Discord-Study-Bot

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

Discord-Study-Bot

★ 26 Open GitHub ↗

Discord-Study-Bot is a Study-Time-based leaderboard system in discord servers. This features an Overall leaderboard and leaderboards based on a Daily, Weekly, and Monthly basis.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Discord-Study-Bot

<a href="https://github.com/shubhayu-64/Discord-Study-Bot/blob/main/LICENSE" alt="Lisence"><img src="https://img.shields.io/github/license/shubhayu-64/Discord-Study-Bot"></a> <a href="https://github.com/shubhayu-64/Discord-Study-Bot/issues" alt="Issues"><img src="https://img.shields.io/github/issues/shubhayu-64/Discord-Study-Bot"></a> <a href="https://twitter.com/intent/follow?screen_name=shubhayu64" alt="Twiter-Follow"><img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fshubhayu64"></a>

Discord-Study-Bot is an open-source solution for implementing a Study-Time-based leaderboard system in discord servers. This open-source programme features an overall leaderboard and leaderboards based on a Daily, Weekly, and Monthly basis which will help a student to concentrate more on their studies.

## Features

- Global Study-Time Leaderboard   
- Monthly Study-Time Leaderboard
- Weekly Study-Time Leaderboard
- Daily Study-Time Leaderboard

## Installation

1. Clone the repo or download manually.
```bash
git clone https://github.com/shubhayu-64/Discord-Study-Bot.git
``` 
2. Move to cloned/downloaded directory ``` cd Discord-Study-Bot```
3. Use [pip](https://pip.pypa.io/en/stable/) to install Discord-Study-Bot. 
```bash
pip install -r requirements.txt
```
4. Make a bot from [Discord Developer Portal](https://discord.com/developers/applications) and grab the token and fill in config.py
5. Make a remote database in [MongoDB](https://www.mongodb.com/) and fill in config.py with your cluster, database, and collection.

## Deploy on heroku
- Create a new app in heroku and choose your relevant region.
- Fork this repo and make it private. 
- Add your API keys or follow 4. and 5. of Installation.
- Add a Procfile with worker as study-bot.py
- Add deployment method as Github in the website.
- Go ahead and deploy on heroku.

## Usage

- Join your Discord bot on your server.
- Build Study text and voice channel and add them in study-bot.py 
![Study Channels](https://i.pinimg.com/originals/2d/b7/43/2db74372de4cbc31f22e5515bfca06e0.png) 
- Replace Channel IDs with your channel IDs.
- Add your studying discord role. 
![Studing Role](https://i.pinimg.com/originals/56/7e/83/567e8373382d1a13973beed20a2f1751.png) 
- Run ``` python study-bot.py```
- Type ``` +help``` in your server.

## FAQ

* I don't see my bot on my server! 
 Invite it by using this URL: https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID&scope=bot 
 Remember to replace CLIENT_ID with your bot client ID
* There aren't that many commands here... 
 Have any suggestion for a feature? Feel free to raise an issue.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.

## What next?
- Add feature to reply back with last study time when a user leaves study room.
- Add a notification when a user overtakes another user in leaderboards. 
Please open an issue with your feature idea.

## 🙋‍♂️ Support

💙 If you like this project, give it a ⭐, share it with friends! 
Feel free to Sponsor this project. ❤️
[☕ Buy me a coffee](https://www.buymeacoffee.com/shubhayu64)

---

Made with ❤️ and Python 
<a href="https://heroku.com/"><img alt="Powered by Heroku" title="Powered by Heroku" src="https://img.shields.io/badge/-Powered%20by%20Heroku-6567a5?style=for-the-badge&logo=heroku&logoColor=white"/></a>

Discord-Study-Bot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README