Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avirsaha/theclassmatebot
The Classmate Bot: Elevating Digital Document Cataloging for Students with Collaborative Excellence. Empowered by Open-Source Innovations. Refer to README for details.
https://github.com/avirsaha/theclassmatebot
ai chatbot database education python seeking-collaborators telegram-bot
Last synced: 16 days ago
JSON representation
The Classmate Bot: Elevating Digital Document Cataloging for Students with Collaborative Excellence. Empowered by Open-Source Innovations. Refer to README for details.
- Host: GitHub
- URL: https://github.com/avirsaha/theclassmatebot
- Owner: avirsaha
- License: other
- Created: 2023-09-07T06:37:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-29T10:30:45.000Z (about 1 year ago)
- Last Synced: 2024-11-09T13:12:09.313Z (2 months ago)
- Topics: ai, chatbot, database, education, python, seeking-collaborators, telegram-bot
- Language: Python
- Homepage:
- Size: 2.88 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# The Classmate Bot - Your Academic Superhero! 🤖📚
## Authors
- Aviraj Saha
- Maithil Saha
## Overview
Welcome to The Classmate Bot, your academic companion in the digital realm! Tired of hunting for study materials and notes when your classmates are unavailable? Fret not, as The Classmate Bot is here to save the day. This Telegram bot simplifies your academic journey by providing instant access to study materials, notes, and more, all in one place. Say goodbye to the stress of chasing down classmates or losing important files—let's make learning a breeze!
For a quick overview of the code base, please refer to the [Implementation Details](./documentation/IMPL_DETAILS.md).
## How it Works
The Classmate Bot may not physically attend your classes, but it's your academic superhero in the virtual world. Here's how it works:
1. **Create or Join Classes**: Easily set up study groups or join existing classes.
2. **Share Documents**: Share and retrieve documents with lightning speed.
3. **Access Anytime**: Access shared files at your convenience.
4. **No More Waiting**: Say farewell to waiting for classmates to be online.
5. **Never Lose Files**: Bid adieu to lost or misplaced documents.
6. **Streamlined Learning**: Simplify your academic journey with Classmate Bot.
## Why The Classmate Bot?
- **Urgent Needs**: When you urgently require study materials, The Classmate Bot is your go-to source.
- **Lost and Found**: No more losing valuable files. The bot preserves vital documents, ensuring they're always at your fingertips.
## Bot Commands
Control The Classmate Bot by sending the following commands via Telegram:
### Profile Commands:
- `/activate`: Start recording.
- `/myprofile`: View your current profile.
- `/deactivate`: Pause recording.
- `/delete`: Remove recordings.
### Class Commands:
- `/my_class`: Check class status.
- `/create_class`: Set up a class.
- `/delete_class`: Remove a class.
- `/join_class`: Join a class.
- `/leave_class`: Exit a class.
### Data Commands:
- `/contribution`: Share materials.
- `/fetchname`: Fetch by name.
- `/fetchdate`: Retrieve by date.
- `/fetchrange`: Get by date-range.
### Utility Commands:
- `/help`: Get assistance.
- `/commands`: List of commands.
- `/feedback`: Share your thoughts.
- `/enquiry`: Ask questions.
- `/open_source`: Learn how it works.
- `/dev`: Access developer tools.
- `/cancel`: Cancel most recent interaction.
Type `/commands` for a comprehensive list of all commands and their functions. Explore these commands to enhance your experience with The Classmate Bot.
## License
The Classmate Bot is distributed under the [GNU General Public License (GPL) version 3](https://www.gnu.org/licenses/gpl-3.0.txt). This means you are free to redistribute and modify the program under the terms of this license. Please refer to the [LICENSE](LICENSE) file for the full license text.
## Contributing
We welcome contributions to The Classmate Bot project! Your ideas, code, and passion can help make academic life easier for students everywhere. Here's how you can get involved:
1. **Fork the Repository**: Start by forking our GitHub repository to your own account.
2. **Clone the Repository**: Clone the forked repository to your local machine.
```bash
git clone https://github.com/your-username/classmate-bot.git
```
3. **Create a New Branch**: Create a new branch for your contributions.
```bash
git checkout -b feature/new-feature
```
4. **Make Changes**: Make your desired changes or additions to the codebase.
5. **Test Your Changes**: Ensure that your changes work as expected and do not introduce errors.
6. **Commit Your Changes**: Commit your changes with a descriptive commit message.
```bash
git commit -m "Add new feature"
```
7. **Push to Your Fork**: Push your changes to your forked repository on GitHub.
```bash
git push origin feature/new-feature
```
8. **Create a Pull Request**: Create a pull request from your forked repository to the original repository.
9. **Review and Collaborate**: Collaborate with other contributors and address any feedback or issues raised during the review process.
10. **Celebrate Your Contribution**: Your code is now part of The Classmate Bot project! 🎉
## Motto
Our motto is to simplify the academic journey of students by providing easy access to study materials and fostering collaboration among learners.
## Acknowledgments
The Classmate Bot project would like to thank all contributors and users for their valuable input and support. Together, we are making academic life easier for students everywhere. Thank you for being a part of this journey! 🌟
[Visit The Classmate Bot on GitHub](https://github.com/avirsaha/theclassmatebot)
If you have any questions, feedback, or suggestions, please don't hesitate to reach out. We'd love to hear from you!
---
© 2023 AVIRAJ SAHA & MAITHIL SAHA. THIS OPEN-SOURCE SOFTWARE IS LICENSED UNDER THE [GPLv3.0](LICENSE) LICENSE.