🧠 CrimsonLearn (CrimsonMind API)
Backend
CrimsonLearn Backend powers CrimsonMind, an AI-driven study assistant that transforms static notes into interactive learning through OCR, quizzes, and contextual explanations.
This backend exposes a REST API that the frontend consumes to provide a seamless learning experience.
✨ Features
📄 OCR Processing – Extracts text from uploaded handwritten or typed notes
🧠 AI Tutor (CrimsonMind) – Answers questions strictly based on provided notes
📝 Quiz Generator – Creates MCQs from notes for active recall
🌐 Frontend-ready API – Designed to integrate with a React/Vite frontend
🛠️ Tech Stack
Backend Framework: Flask
AI Model: Google Gemini
OCR: Tesseract OCR + Pillow
Language: Python 3
Environment Management: python-dotenv
📁 Project Structure backend/ │ ├── app.py # Flask app & routes ├── chatbot.py # CrimsonMind AI logic ├── quiz.py # Quiz generation logic ├── ocr.py # OCR text extraction ├── requirements.txt # Python dependencies ├── .env # API keys (not committed) └── uploads/ # Uploaded note images
🔌 API Endpoints 📄 Upload Notes (OCR)
POST /api/upload
Input: Image file (PNG/JPG)
Output: Extracted text
📝 Generate Quiz
POST /api/generateQuiz
{ "notes": "your notes here", "num_questions": 5 }
🧠 Ask CrimsonMind
POST /api/chat
{ "notes": "your notes here", "question": "your question here" }
⚙️ Setup Instructions 1️⃣ Clone & Navigate git clone https://github.com/AdarshAlex751/crimsonmind cd backend
2️⃣ Create Virtual Environment python -m venv venv source venv/bin/activate # Windows: venv\Scripts\activate
3️⃣ Install Dependencies pip install -r requirements.txt
4️⃣ Configure Environment
Create a .env file:
GEMINI_API_KEY=your_api_key_here
5️⃣ Run the Server python app.py
Server runs on:
🚀 Purpose
This backend focuses on conceptual learning, ensuring AI responses stay grounded in the user’s own study material rather than generic explanations.
Frontend
Built with performance and clean UI in mind.
✨ Features
📄 Upload notes for OCR processing
🧠 Chat with CrimsonMind AI
📝 Generate quizzes instantly
🎨 Smooth animations & modern UI
🌙 Automatic dark/light mode
🛠️ Tech Stack
Framework: React (Vite)
Styling: Tailwind CSS
Animations: Framer Motion
Icons: Lucide React
HTTP Client: Axios
📁 Project Structure frontend/ │ ├── index.html ├── src/ │ ├── main.jsx │ ├── App.jsx │ └── components/ ├── tailwind.config.js ├── postcss.config.js ├── vite.config.js ├── package.json └── package-lock.json
⚙️ Setup Instructions 1️⃣ Navigate to Frontend cd frontend
2️⃣ Install Dependencies npm install
3️⃣ Start Development Server npm run dev
Frontend runs at:
The frontend is preconfigured to proxy API requests to the Flask backend.
🔁 Backend Connection
The frontend communicates with the backend via:
/api → http://127.0.0.1:5000
Make sure the backend server is running before using the app.
🎯 Design Philosophy
Minimal distractions
Fast feedback loops
Learning through interaction, not passive reading
🔮 Future Improvements
User authentication
Study progress tracking
Concept graphs & analytics
PDF and multi-page uploads
Voice-based interaction