UniPrep Copilot

AI-Powered Academic Assistant for University Students

Features • Demo • Installation • Tech Stack • Documentation

Overview

UniPrep Copilot is an intelligent academic companion that leverages AI to help university students excel in their studies. Upload your syllabus, past papers, and notes—then let AI generate personalized study materials, exam prep resources, and revision plans tailored to your university, branch, and answer style preferences.

Features

Academic Intelligence

University-Aware Context: Specify university, college, branch, semester, and subjects
Smart Content Upload: Upload syllabus PDFs, past year papers, notes, and reference materials
Context-Driven Generation: AI analyzes your uploaded materials for accurate, relevant content

AI-Powered Content Generation

Study Notes: Auto-generate comprehensive notes from topics
Academic Reports: Create well-structured reports with proper formatting
PPT Content: Generate presentation-ready slide content
Exam Blueprints: Strategic exam preparation roadmaps
Revision Planners: Time-based revision schedules aligned with exam dates
Rapid Revision Sheets: Quick-reference study materials
Mock Papers: AI-generated practice papers based on PYQs

Personalization

Answer Style Profiles: Create custom writing styles (concise, detailed, academic, etc.)
Style Templates: Choose from preset styles or build your own
Adaptive Formatting: Tone, structure, and word count customization

Community Features

Content Sharing: Share and discover study materials from peers
Discussion Forums: Engage with fellow students
Upvote/Downvote System: Community-curated content quality

Progress Tracking

Study Analytics: Track study time, topics covered, and progress
Quiz System: Test your knowledge with auto-generated quizzes
Focus Mode: Distraction-free study sessions with timer
Study Streaks: Maintain daily study momentum

Demo

Landing Page

Authentication

Dashboard

Installation

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (v18 or higher) - Download
MongoDB Atlas account - Sign up
OpenRouter API Key - Get API Key

Quick Start

Clone the repository

git clone https://github.com/yourusername/uniprep-copilot.git
cd uniprep-copilot

Install dependencies

# Install backend dependencies
cd backend
npm install

# Install frontend dependencies
cd ../frontend
npm install
cd ..

Configure Environment Variables

Backend - Create backend/.env:

PORT=5000
NODE_ENV=development

# MongoDB
MONGO_URI=mongodb+srv://username:password@cluster.mongodb.net/uniprep?retryWrites=true&w=majority

# JWT Configuration
JWT_SECRET=your-super-secret-jwt-key-min-32-chars
JWT_REFRESH_SECRET=your-refresh-secret-key-min-32-chars
JWT_ACCESS_EXPIRES_IN=15m
JWT_REFRESH_EXPIRES_IN=7d

# OpenRouter AI
OPENROUTER_API_KEY=sk-or-v1-your-api-key-here
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
OPENROUTER_MODEL=openai/gpt-4o-mini

# URLs
BACKEND_URL=http://localhost:5000
CLIENT_URL=http://localhost:5173

# Cloudinary (optional - for image uploads)
CLOUDINARY_CLOUD_NAME=your-cloud-name
CLOUDINARY_API_KEY=your-api-key
CLOUDINARY_API_SECRET=your-api-secret

Frontend - Create frontend/.env:

VITE_API_URL=http://localhost:5000/api

Start Development Servers

Option 1: Run both servers separately

# Terminal 1 - Backend
cd backend
npm run dev

# Terminal 2 - Frontend
cd frontend
npm run dev

Access the Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:5000/api

Tech Stack

Frontend

Technology	Version	Purpose
React	19.2	UI Framework
Vite	7.0	Build Tool
Tailwind CSS	3.4	Styling
React Router	7.10	Routing
Zustand	5.0	State Management
Axios	1.13	HTTP Client
Lucide React	0.561	Icons
Recharts	3.5	Charts & Analytics

Backend

Technology	Version	Purpose
Node.js	18+	Runtime
Express.js	4.18	Web Framework
MongoDB	8.0	Database
Mongoose	8.0	ODM
OpenRouter	SDK 0.2	AI Integration
JWT	9.0	Authentication
Bcrypt	2.4	Password Hashing
Multer	1.4	File Uploads
PDF Parse	1.1	PDF Extraction

AI & Services

OpenRouter: Multi-model AI gateway (GPT-4, Claude, Gemini, etc.)
Cloudinary: Media management (optional)

Project Structure

uniprep-copilot/
├── backend/
│   ├── config/
│   │   ├── db.js                    # MongoDB connection
│   │   └── cloudinaryConfig.js      # Cloudinary setup
│   ├── controllers/
│   │   ├── authController.js        # Authentication logic
│   │   ├── userController.js        # User management
│   │   ├── subjectController.js     # Subject CRUD
│   │   ├── contextController.js     # Context upload/management
│   │   ├── styleController.js       # Answer style profiles
│   │   ├── contentController.js     # Content generation
│   │   ├── examController.js        # Exam prep features
│   │   ├── quizController.js        # Quiz system
│   │   ├── sessionController.js     # Study sessions
│   │   └── communityController.js   # Community features
│   ├── middleware/
│   │   └── auth.js                  # JWT verification
│   ├── models/
│   │   ├── User.js                  # User schema
│   │   ├── Subject.js               # Subject schema
│   │   ├── Context.js               # Uploaded context schema
│   │   ├── AnswerStyle.js           # Style profile schema
│   │   ├── GeneratedContent.js      # AI content schema
│   │   ├── ExamPlan.js              # Exam blueprint schema
│   │   ├── Quiz.js                  # Quiz schema
│   │   ├── Session.js               # Study session schema
│   │   └── Community*.js            # Community schemas
│   ├── routes/
│   │   ├── auth.js                  # Auth endpoints
│   │   ├── users.js                 # User endpoints
│   │   ├── subjects.js              # Subject endpoints
│   │   ├── context.js               # Context endpoints
│   │   ├── styles.js                # Style endpoints
│   │   ├── content.js               # Content generation endpoints
│   │   ├── exam.js                  # Exam endpoints
│   │   ├── quiz.js                  # Quiz endpoints
│   │   ├── sessions.js              # Session endpoints
│   │   └── community.js             # Community endpoints
│   ├── services/
│   │   └── aiOrchestrator.js        # AI prompt engineering & API calls
│   ├── utils/
│   │   └── generateToken.js         # JWT utilities
│   ├── .env.sample                  # Environment template
│   ├── package.json
│   └── server.js                    # Express app entry point
│
├── frontend/
│   ├── public/
│   │   ├── logo.png                 # App logo
│   │   ├── Home.png                 # Landing page screenshot
│   │   ├── SignUp.png               # Auth screenshot
│   │   └── Dashboard.png            # Dashboard screenshot
│   ├── src/
│   │   ├── components/
│   │   │   ├── common/
│   │   │   │   └── PrivateRoute.jsx # Route protection
│   │   │   ├── layout/
│   │   │   │   ├── Header.jsx       # Top navigation
│   │   │   │   ├── Sidebar.jsx      # Side navigation
│   │   │   │   ├── Footer.jsx       # Footer component
│   │   │   │   └── Layout.jsx       # Layout wrapper
│   │   │   ├── content/
│   │   │   │   ├── ContextManager.jsx       # Upload/manage contexts
│   │   │   │   ├── NotesGenerator.jsx       # Notes generation UI
│   │   │   │   ├── ReportGenerator.jsx      # Report generation UI
│   │   │   │   ├── PPTGenerator.jsx         # PPT generation UI
│   │   │   │   └── ContentList.jsx          # List generated content
│   │   │   └── exam/
│   │   │       ├── ExamMode.jsx             # Exam prep hub
│   │   │       ├── BlueprintView.jsx        # Blueprint display
│   │   │       ├── PlannerView.jsx          # Planner display
│   │   │       ├── RapidSheetsGenerator.jsx # Rapid sheets
│   │   │       └── MockPaperGenerator.jsx   # Mock paper gen
│   │   ├── pages/
│   │   │   ├── Landing.jsx          # Landing page
│   │   │   ├── Login.jsx            # Auth page
│   │   │   ├── Dashboard.jsx        # Main dashboard
│   │   │   ├── Subjects.jsx         # Subject management
│   │   │   ├── SubjectWorkspace.jsx # Subject detail view
│   │   │   ├── Styles.jsx           # Style profiles
│   │   │   ├── Community.jsx        # Community feed
│   │   │   ├── PostDetail.jsx       # Post detail view
│   │   │   ├── FocusMode.jsx        # Focus study mode
│   │   │   ├── ContentView.jsx      # Content viewer
│   │   │   └── Profile.jsx          # User profile
│   │   ├── services/
│   │   │   └── api.js               # Axios instance & interceptors
│   │   ├── store/
│   │   │   └── authStore.js         # Zustand auth store
│   │   ├── App.jsx                  # App router
│   │   ├── main.jsx                 # React entry point
│   │   └── index.css                # Global styles
│   ├── .env.sample
│   ├── index.html
│   ├── package.json
│   ├── postcss.config.js
│   ├── tailwind.config.js
│   └── vite.config.js
│
├── LICENSE.md
└── README.md

Documentation

API Endpoints

Authentication

POST /api/auth/register - Register new user
POST /api/auth/login - User login
POST /api/auth/refresh - Refresh access token
GET /api/auth/me - Get current user

Subjects

GET /api/subjects - List all subjects
POST /api/subjects - Create subject
GET /api/subjects/:id - Get subject details
PUT /api/subjects/:id - Update subject
DELETE /api/subjects/:id - Delete subject

Context Management

POST /api/context/upload - Upload context files (PDF, text)
GET /api/context - List all contexts
GET /api/context/search - Search contexts
DELETE /api/context/:id - Delete context

Content Generation

POST /api/content/notes - Generate study notes
POST /api/content/report - Generate academic report
POST /api/content/ppt - Generate PPT content
GET /api/content - List generated content
DELETE /api/content/:id - Delete content

Exam Preparation

POST /api/exam/blueprint - Generate exam blueprint
POST /api/exam/planner - Create revision planner
POST /api/exam/rapid-sheets - Generate rapid revision sheets
POST /api/exam/mock-paper - Generate mock paper

Answer Styles

GET /api/styles - List all styles
POST /api/styles - Create new style
PUT /api/styles/:id - Update style
DELETE /api/styles/:id - Delete style
PUT /api/styles/:id/default - Set default style

Community

GET /api/community/posts - Get all posts
POST /api/community/posts - Create post
POST /api/community/posts/:id/vote - Vote on post
POST /api/community/posts/:id/comment - Comment on post

Database Models

User Model

{
  name: String,
  email: String (unique),
  password: String (hashed),
  university: String,
  college: String,
  branch: String,
  semester: Number,
  subjects: [ObjectId],
  activeStyle: ObjectId,
  examDates: [{ subject, date }],
  studyStreak: Number,
  createdAt: Date
}

Subject Model

{
  user: ObjectId,
  name: String,
  code: String,
  semester: Number,
  credits: Number,
  examDate: Date,
  contexts: [ObjectId]
}

Context Model

{
  user: ObjectId,
  subject: ObjectId,
  type: String, // 'syllabus', 'pyq', 'notes', 'reference'
  title: String,
  content: String,
  fileUrl: String,
  metadata: Object
}

GeneratedContent Model

{
  user: ObjectId,
  subject: ObjectId,
  type: String, // 'notes', 'report', 'ppt', etc.
  title: String,
  content: String,
  style: ObjectId,
  contexts: [ObjectId],
  createdAt: Date
}

Usage Guide

1. Getting Started

Sign up and complete your profile
Add subjects for your current semester
Upload contexts (syllabus, PYQs, notes)
Create or select an answer style profile

2. Generating Study Materials

Navigate to a subject workspace
Select content type (Notes/Report/PPT)
Choose relevant contexts
Specify topics or let AI auto-extract
Generate and review content
Save or export for later use

3. Exam Preparation

Set exam dates in subject settings
Generate exam blueprint for strategic overview
Create revision planner with time allocation
Generate rapid revision sheets for quick review
Practice with AI-generated mock papers

4. Focus Mode

Select content to study
Set timer duration
Enter distraction-free full-screen mode
Track study time automatically

Environment Variables

Required Variables

Variable	Description	Example
`MONGO_URI`	MongoDB connection string	`mongodb+srv://...`
`JWT_SECRET`	JWT signing secret (min 32 chars)	`your-secret-key`
`OPENROUTER_API_KEY`	OpenRouter API key	`sk-or-v1-...`

Optional Variables

Variable	Description	Default
`PORT`	Backend server port	`5000`
`NODE_ENV`	Environment mode	`development`
`OPENROUTER_MODEL`	AI model to use	`openai/gpt-4o-mini`
`CLOUDINARY_*`	Cloudinary credentials	N/A

Troubleshooting

Common Issues

1. MongoDB Connection Failed

Error: Could not connect to MongoDB

Verify MONGO_URI is correct
Check MongoDB Atlas IP whitelist
Ensure network connectivity

2. OpenRouter API Errors

Error: Invalid API key

Verify API key is correct and active
Check account credits on OpenRouter
Ensure OPENROUTER_API_KEY is set in .env

3. Frontend Can't Connect to Backend

Error: Network Error

Verify backend is running (npm run dev in backend folder)
Check VITE_API_URL in frontend .env
Ensure CORS is configured correctly

4. File Upload Issues

Error: File too large

Backend has 50MB upload limit
Check file size and format (PDF recommended)
Ensure multer middleware is properly configured

Contributing

Contributions are welcome! Please follow these steps:

Fork the repository
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

Development Guidelines

Follow ESLint configuration
Write meaningful commit messages
Add comments for complex logic
Update documentation for new features
Test thoroughly before submitting PR

License

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

Contributors

Thanks to these wonderful people who have contributed to this project:

_{Your Name}
_{Project Lead}

How to Add Your Name

Fork the repository

Add your details in the Contributors table above:

<td align="center">
  <a href="https://github.com/your-username">
    <img src="https://github.com/your-username.png" width="100px;" alt="Your Name"/>
    <br />
    <sub><b>Your Name</b></sub>
  </a>
  <br />
  <sub>Your Role/Contribution</sub>
</td>

Create a Pull Request

Acknowledgments

OpenRouter for AI infrastructure
MongoDB for database solutions
React and Vite teams for excellent tooling
Tailwind CSS for styling framework
All contributors and testers

<<<<<<< HEAD

=======

4db8516 (resolve the loading issue)

Made with ❤️ for students, by students

Back to Top

Name		Name	Last commit message	Last commit date
Latest commit History 41 Commits
backend		backend
frontend		frontend
.gitignore		.gitignore
LICENSE.md		LICENSE.md
README.md		README.md

License

Avoy-Sasmal/UniPrep

Folders and files

Latest commit

History

Repository files navigation

UniPrep Copilot

AI-Powered Academic Assistant for University Students

Overview

Features

Academic Intelligence

AI-Powered Content Generation

Personalization

Community Features

Progress Tracking

Demo

Landing Page

Authentication

Dashboard

Installation

Prerequisites

Quick Start

Tech Stack

Frontend

Backend

AI & Services

Project Structure

Documentation

API Endpoints

Authentication

Subjects

Context Management

Content Generation

Exam Preparation

Answer Styles

Community

Database Models

User Model

Subject Model

Context Model

GeneratedContent Model

Usage Guide

1. Getting Started

2. Generating Study Materials

3. Exam Preparation

4. Focus Mode

Environment Variables

Required Variables

Optional Variables

Troubleshooting

Common Issues

Contributing

Development Guidelines

License

Contributors

How to Add Your Name

Acknowledgments

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Uh oh!

Languages

Packages