█████╗ ██╗ ██╗ ███████╗████████╗██╗ ██╗██████╗ ██╗ ██████╗
██╔══██╗██║ ██║ ██╔════╝╚══██╔══╝██║ ██║██╔══██╗██║██╔═══██╗
███████║██║ ██║ ███████╗ ██║ ██║ ██║██║ ██║██║██║ ██║
██╔══██║██║ ██║ ╚════██║ ██║ ██║ ██║██║ ██║██║██║ ██║
██║ ██║██║ ███████╗ ███████║ ██║ ╚██████╔╝██████╔╝██║╚██████╔╝
╚═╝ ╚═╝╚═╝ ╚══════╝ ╚══════╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═════╝
✨ Live Demo · 📖 Documentation · 🐛 Report Bug · 💡 Request Feature
AI Study is a full-stack, AI-powered learning assistant built for students and self-learners who want to study smarter, not harder. Upload your documents, chat with an AI tutor, auto-generate quizzes, and track your progress — all in one seamless platform.
Whether you're cramming for exams, mastering a new skill, or exploring a subject out of curiosity — AI Study adapts to your pace, your materials, and your goals.
Engage in real-time, context-aware conversations with an AI tutor trained to explain complex concepts simply. Ask follow-up questions, request analogies, get code explanations — your tutor never gets tired.
- Powered by OpenAI / Gemini API for blazing-fast, intelligent responses
- Remembers conversation context for multi-turn dialogues
- Handles STEM, humanities, programming, and more
Upload your lecture notes, textbooks, or research papers and let the AI extract knowledge from them instantly.
- Drag-and-drop file upload interface
- AI reads, parses, and understands document content
- Ask questions directly about your uploaded content
- Supports PDF, DOCX, and TXT formats
Stop making flashcards manually. Let the AI generate custom quizzes from your study material in seconds.
- Auto-generates MCQ, True/False, and short-answer questions
- Difficulty levels: Easy → Medium → Hard
- Instant feedback and explanations for wrong answers
- Powered by document context for hyper-relevant questions
Visualize your learning journey. Know what you've studied, where you're excelling, and what needs more attention.
- Personal dashboard with study streaks and session history
- Quiz score analytics over time
- Topic-wise performance breakdown
- Motivating milestones and insights
| Layer | Technology | Purpose |
|---|---|---|
| Frontend | Next.js (React) | UI, routing, server-side rendering |
| Backend | Node.js + Express | REST API, business logic |
| Database | MongoDB | User data, sessions, quiz results |
| AI Engine | OpenAI / Gemini API | Chat, Q&A, quiz generation |
| Auth | JWT / Firebase Auth | Secure user authentication |
| File Handling | Multer / PDFParse | Document upload & text extraction |
| Styling | Tailwind CSS | Responsive, utility-first design |
AI-Learning-Assistant/
│
├── 📁 frontend/ # Next.js React Application
│ ├── 📁 app/ # App Router (Next.js 13+)
│ │ ├── 📁 (auth)/ # Auth pages — login, signup
│ │ ├── 📁 dashboard/ # Progress dashboard
│ │ ├── 📁 chat/ # AI Chat interface
│ │ ├── 📁 quiz/ # Quiz generation & attempt
│ │ └── 📁 upload/ # Document upload & analysis
│ ├── 📁 components/ # Reusable UI components
│ ├── 📁 lib/ # Utility functions & API calls
│ └── 📁 public/ # Static assets
│
├── 📁 backend/ # Node.js + Express Server
│ ├── 📁 routes/ # API route definitions
│ │ ├── auth.js # Authentication endpoints
│ │ ├── chat.js # AI Chat endpoints
│ │ ├── quiz.js # Quiz generation & submission
│ │ ├── upload.js # File upload endpoints
│ │ └── progress.js # User progress endpoints
│ ├── 📁 controllers/ # Route handler logic
│ ├── 📁 models/ # MongoDB Mongoose schemas
│ │ ├── User.js # User model
│ │ ├── Quiz.js # Quiz & results model
│ │ ├── Document.js # Uploaded document model
│ │ └── Progress.js # Progress tracking model
│ ├── 📁 middleware/ # Auth, error handling
│ ├── 📁 utils/ # Helper utilities
│ ├── 📁 config/ # DB & environment config
│ └── server.js # Express app entry point
│
├── .env.example # Environment variable template
├── .gitignore
├── package.json
└── README.md
Make sure you have the following installed:
- Node.js v18 or higher
- npm or yarn
- MongoDB (local or MongoDB Atlas)
- An OpenAI or Gemini API key
git clone https://github.com/TechGenDM/AI-Learning-Assistant.git
cd AI-Learning-AssistantCreate a .env file in the /backend directory:
# Server
PORT=5000
NODE_ENV=development
# Database
MONGO_URI=your_mongodb_connection_string
# Authentication
JWT_SECRET=your_super_secret_jwt_key
# AI API
OPENAI_API_KEY=your_openai_api_key
# OR
GEMINI_API_KEY=your_gemini_api_keyCreate a .env.local file in the /frontend directory:
NEXT_PUBLIC_API_URL=http://localhost:5000/apiBackend:
cd backend
npm installFrontend:
cd frontend
npm installStart the backend server:
cd backend
npm run dev
# Server running at http://localhost:5000Start the frontend:
cd frontend
npm run dev
# App running at http://localhost:3000Now open http://localhost:3000 in your browser. 🎉
| Method | Endpoint | Description |
|---|---|---|
POST |
/api/auth/register |
Register a new user |
POST |
/api/auth/login |
Login & receive JWT token |
GET |
/api/chat |
Fetch chat history |
POST |
/api/chat/message |
Send message to AI tutor |
POST |
/api/upload |
Upload a PDF/document |
GET |
/api/upload/:id/analyze |
Analyze uploaded document |
POST |
/api/quiz/generate |
Generate quiz from document/topic |
POST |
/api/quiz/submit |
Submit quiz answers |
GET |
/api/progress |
Get user progress & analytics |
GET |
/api/progress/history |
Get session history |
Full API documentation available in
/backend/docs/api.md
| Dashboard | AI Chat | Quiz Generation |
|---|---|---|
| 📊 | 💬 | 🧠 |
| Progress overview & analytics | Context-aware AI tutor | Auto-generated assessments |
📌 Add screenshots of your app here by placing images in
/public/screenshots/and updating this section.
- AI Chat & Q&A with conversation memory
- PDF & document upload and analysis
- Quiz generation from document content
- User progress tracking & dashboard
- 🔜 Spaced repetition flashcard system
- 🔜 Multi-language support
- 🔜 Collaborative study rooms
- 🔜 Voice-to-text input for chat
- 🔜 Mobile app (React Native)
- 🔜 AI-generated study plans & roadmaps
Contributions are what make the open-source community amazing. Any contributions you make are greatly appreciated!
- Fork the project
- Create your feature branch:
git checkout -b feature/AmazingFeature - Commit your changes:
git commit -m 'Add some AmazingFeature' - Push to the branch:
git push origin feature/AmazingFeature - Open a Pull Request
Please read CONTRIBUTING.md for details on our code of conduct and contribution guidelines.
Found a bug? Have a suggestion?
👉 Open an Issue with:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected vs. actual behavior
- Screenshots if applicable
Distributed under the MIT License. See LICENSE for more information.
- OpenAI — For the powerful AI API
- Next.js — The React framework for production
- MongoDB — Flexible, scalable database
- Tailwind CSS — Utility-first CSS framework
- Vercel — Seamless frontend deployment
Built with ❤️ by TechGenDM
If this project helped you, please consider giving it a ⭐ — it means the world!
