FlashMindsBot

🚀 FlashMinds revolutionizes the way you learn by combining the simplicity of flashcards with the power of artificial intelligence. In addition to traditional flashcard functionality, FlashMinds employs advanced AI algorithms to enhance your learning experience.

Table of contents
Introduction
Documentation
Getting Started
- Prerequisites
Usage
Contributors
Acknowledgments

Introduction

Welcome to FlashMinds, where learning meets innovation! Our Telegram Bot redefines the learning experience by seamlessly integrating the simplicity of flashcards with the transformative power of artificial intelligence. Explore a new dimension of learning with these features:

📚 Smart Flashcards
Create flashcards effortlessly using our innovative generator. Simply send an image containing text to the bot, and it will generate a question-answer pair based on the image content. Alternatively, you can manually input questions and answers.
✨ AI-Powered
Leverage advanced AI algorithms that analyze your progress and suggest tailored study materials. In study mode, FlashMinds utilizes ChatGPT to dynamically generate questions based on your saved card. This ensures varied questions while covering the same material, providing a diverse learning experience. Additionally, our algorithm identifies questions that students typically find challenging at the beginning of a session, helping you focus on areas that need attention.
🧑‍🎓Interactive Quizzes
In study mode, students can view a question, reveal the answer, and self-assess their response. This interactive process enhances the learning experience, allowing for immediate reflection and improvement.
⭐️ Progress Tracking
Keep tabs on your learning journey. FlashMinds provides insights into your progress, helping you identify strengths and areas for improvement.
📱 Cross-Platform Accessibility
Access your study materials anytime, anywhere with the convenience of Telegram. FlashMinds is accessible through any Telegram app, whether on mobile or desktop. Seamlessly pick up where you left off and continue your learning journey effortlessly.

Documentation

Explore and test the API using our Postman Collections:

These collections includes pre-configured requests for various endpoints, making it easier to interact with the APIs.

Getting Started

Before you get started,

Get your OpenAI API key
Get your Telegram bot token from @BotFather

Prerequisites

Make sure you have Docker and Docker Compose installed on your machine.

Usage

To run this project, you can use Docker and Docker Compose. Follow these steps:

Clone the repository to your local machine.

git clone https://github.com/glonor/flashminds
cd flashminds

Create a .env file in the project root and configure these variables:

#Telegram Bot
TELEGRAM_BOT_TOKEN=your_telegram_bot_token_here

#ChatGPT 3.5 API
CHATGPT_API_KEY=your_chatgpt_api_key_here

Make sure not to share or commit your .env file to keep your sensitive information private.

Build and run the project using Docker Compose.

docker-compose up --build

This command will build the Docker images and start the containers based on the configuration in the docker-compose.yml file.

Access your Telegram Bot. Once the containers are running, you can access your FlashMindsBot via Telegram.

Contributors

Acknowledgments

Ebisu: Utilized Ebisu for smart scheduling service.
ChatGPT: Powered by OpenAI's GPT-3.5 language model.
Tesseract: Used Tesseract for OCR service.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

glonor/flashminds