Edulume - AI-Powered Educational Platform

🎉 SWOC 2026 - Social Winter of Code

We're excited to be part of Social Winter of Code 2026! This is a great opportunity for open-source enthusiasts to contribute to a real-world educational platform.

For SWOC Participants

• 🏷️ Check issues labeled swoc2026, good first issue, help wanted
• 📖 Read CONTRIBUTING.md before starting
• 💬 Join discussions and ask questions in issues
• ⭐ Star the repo to show your support!

🌟 Features

Core Features

• User Authentication - Local signup/login with OTP verification + Google OAuth
• Resource Sharing - Upload and browse PDFs/ebooks by semester, course, department
• Discussion Forum - Community Q&A with voting, best answers, and @mentions
• Courses - Create structured courses with AI-generated content and progress tracking
• Roadmaps - Generate learning roadmaps with resources, tools, and career guidance
• AI PDF Chatbot - Chat with uploaded PDFs using RAG (Retrieval-Augmented Generation)
• Admin Panel - Manage users, content, feature suggestions, and bug reports

Advanced Features

• Real-time Updates - WebSocket support for live notifications
• AI Content Generation - Groq-powered course outlines and chapter content
• Vector Database - Pinecone integration for semantic PDF search
• Caching - Redis caching for improved performance
• Email Notifications - OTP and notification emails via SMTP
• File Storage - Cloudinary and R2 (Backblaze) integration
• SEO Optimization - Sitemap generation and metadata

🏗️ Architecture

┌─────────────────────────────────────────────────────────────┐
│                    Frontend (Client)                         │
│         React 19 + TypeScript + Tailwind CSS + Vite         │
│                    Deployed on Vercel                        │
└─────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────┐
│                  Backend (Node.js Server)                    │
│          Express.js + Prisma + MongoDB + Socket.io          │
│                    Deployed on Fly.io                        │
└─────────────────────────────────────────────────────────────┘
                              ↓
┌─────────────────────────────────────────────────────────────┐
│               AI Backend (Python FastAPI)                    │
│          FastAPI + LangChain + Pinecone + Groq              │
│                    Deployed on Fly.io                        │
└─────────────────────────────────────────────────────────────┘

🛠️ Tech Stack

📁 Project Structure

edulume/
├── client/                 # React frontend
│   ├── src/
│   │   ├── components/     # React components
│   │   ├── hooks/          # Custom hooks
│   │   ├── utils/          # Utility functions
│   │   └── types/          # TypeScript types
│   └── public/             # Static assets
│
├── server/                 # Express.js backend
│   ├── routes/             # API routes
│   ├── middleware/         # Express middleware
│   ├── config/             # Configuration
│   ├── socket/             # Socket.io handlers
│   ├── prisma/             # Prisma schema
│   └── utils/              # Utility functions
│
└── python-backend/         # FastAPI AI backend
    ├── fileUpload/         # PDF upload handlers
    ├── RAGresponse/        # RAG implementation
    └── sessionCleanup/     # Session management

🚀 Quick Start

Prerequisites

• Node.js v20.12.2+
• Python 3.11+
• MongoDB (local or Atlas)
• Git

Installation

# Clone the repository
git clone https://github.com/tarinagarwal/edulume.git
cd edulume

# Frontend setup
cd client
npm install
cp .env.example .env  # Configure environment variables
npm run dev

# Backend setup (new terminal)
cd server
npm install
cp .env.example .env  # Configure environment variables
npm run db:generate
npm run dev

# Python backend setup (new terminal)
cd python-backend
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
cp .env.example .env  # Configure environment variables
uvicorn main:app --reload

Running with Docker

1. Ensure you have Docker and Docker Compose installed.
2. Configure .env file:

   cp .env.example .env

3. Update .env with your API keys and configuration.
4. Run the application:

   docker-compose up --build

5. Access the application:
   • Client: http://localhost
   • Server: http://localhost:3000
   • Python Backend: http://localhost:8080

📖 For detailed setup instructions, see INSTALLATION.md

🔌 API Overview

🤝 Contributing

We welcome contributions from everyone! Whether you're fixing bugs, adding features, or improving documentation.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📖 Read CONTRIBUTING.md for detailed guidelines

Good First Issues

Looking for a place to start? Check out issues labeled:

• good first issue - Perfect for newcomers
• help wanted - We need your help!
• documentation - Help improve our docs
• bug - Help us squash bugs

📊 Database Models

🔐 Environment Variables

Key environment variables needed:

📖 See INSTALLATION.md for complete environment setup

📄 License

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

🙏 Acknowledgments

• All our amazing contributors
• SWOC 2026 for the opportunity
• Open source community

📞 Support

• 📧 Create an issue for bugs or feature requests
• 💬 Use in-app feedback system
• ⭐ Star this repo if you find it helpful!