CampusCurator 🎓

A comprehensive campus-wide platform connecting students, mentors, and administrators to manage academic project drives efficiently through all stages - from group formation to final results.

🌟 Features

For Students

📝 View and join active project drives
👥 Create or join project groups with invitation codes
🎯 Set mentor preferences for group allotment
📄 Submit project synopsis for mentor approval
📊 Submit checkpoint evaluations (mid-sem, end-sem)
🏆 View evaluation feedback and final results

For Mentors

👀 View assigned groups and student details
✅ Review and approve/reject project synopsis
📝 Evaluate checkpoint submissions
💬 Provide feedback and improvement suggestions
📈 Track student progress throughout the drive

For Admins

🚀 Create and manage project drives
👥 Manage student batches and mentor lists
⚙️ Configure group sizes and mentor capacity
🔄 Manual or automatic mentor allotment
📊 View comprehensive drive statistics
🎯 Manage stage transitions and deadlines
📢 Declare and publish final results

🏗️ Architecture

Tech Stack

Backend: Node.js, Express.js
Database: MongoDB (Atlas)
ODM: Mongoose
Authentication: JWT (JSON Web Tokens)
File Upload: Multer
Validation: express-validator

Project Stages

Drive Creation - Admin sets up project drive with configuration
Group Formation - Students create/join groups with invitation codes
Mentor Allotment - Manual or automatic mentor assignment
Synopsis Submission - Groups submit project proposals for approval
Checkpoints/Evaluations - Progress tracking through multiple evaluations
Result Declaration - Final consolidated results publication

📁 Project Structure

CampusCurator/
├── backend/                    # Node.js/Express API
│   ├── config/                # Configuration files
│   │   └── database.js       # MongoDB connection
│   ├── controllers/          # Business logic
│   │   ├── authController.js
│   │   ├── driveController.js
│   │   └── groupController.js
│   ├── middleware/           # Express middleware
│   │   ├── auth.js          # JWT authentication
│   │   ├── errorHandler.js  # Error handling
│   │   └── upload.js        # File upload config
│   ├── models/              # Mongoose schemas
│   │   ├── User.js
│   │   ├── Drive.js
│   │   ├── Group.js
│   │   ├── Synopsis.js
│   │   ├── CheckpointSubmission.js
│   │   ├── Evaluation.js
│   │   ├── Result.js
│   │   └── Notification.js
│   ├── routes/              # API routes
│   │   ├── auth.js
│   │   ├── drives.js
│   │   ├── groups.js
│   │   ├── synopsis.js
│   │   ├── checkpoints.js
│   │   ├── evaluations.js
│   │   ├── results.js
│   │   └── notifications.js
│   ├── uploads/            # File storage
│   ├── .env.example       # Environment template
│   ├── package.json
│   ├── server.js         # Entry point
│   └── README.md        # Backend docs
├── database/                # Database documentation
│   ├── SCHEMA.md          # Complete schema reference
│   └── DATABASE_SETUP.md # MongoDB Atlas setup guide
├── QUICKSTART.md         # Quick setup guide
├── README.md            # This file
└── LICENSE

🚀 Quick Start

Prerequisites

Node.js (v14+)
npm or yarn
MongoDB Atlas account (free tier)

1. Clone Repository

git clone https://github.com/ankitsingh015/CampusCurator.git
cd CampusCurator

2. Setup MongoDB Atlas

Follow the detailed guide in database/DATABASE_SETUP.md to:

Create a free MongoDB Atlas cluster
Set up database user and network access
Get your connection string

3. Install & Configure Backend

cd backend
npm install
cp .env.example .env
# Edit .env with your MongoDB URI and other configs

4. Start Server

npm run dev

Server runs at http://localhost:5000

5. Test API

# Health check
curl http://localhost:5000/health

# Register admin user
curl -X POST http://localhost:5000/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Admin",
    "email": "admin@example.com",
    "password": "admin123",
    "role": "admin"
  }'

📖 For detailed setup instructions, see QUICKSTART.md

📚 Documentation

Quick Start Guide - Get up and running in 5 steps
Database Setup - MongoDB Atlas configuration
Database Schema - Complete schema documentation
Backend API - API endpoints and usage

🔑 API Endpoints

Authentication

POST   /api/auth/register    - Register new user
POST   /api/auth/login       - Login user
GET    /api/auth/me          - Get current user
GET    /api/auth/logout      - Logout user

Drives (Admin)

POST   /api/drives           - Create drive
GET    /api/drives           - List drives
GET    /api/drives/:id       - Get drive details
PUT    /api/drives/:id       - Update drive
DELETE /api/drives/:id       - Delete drive
GET    /api/drives/:id/stats - Get statistics
PUT    /api/drives/:id/stage - Update stage

Groups (Students)

POST   /api/groups                      - Create group
GET    /api/groups                      - List groups
GET    /api/groups/:id                  - Get group details
POST   /api/groups/join                 - Join with code
PUT    /api/groups/:id/members/:mid    - Manage members
DELETE /api/groups/:id                  - Delete group
PUT    /api/groups/:id/mentor          - Allot mentor (Admin)
POST   /api/groups/auto-allot/:driveId - Auto-allot (Admin)

Full API documentation in backend/README.md

🗄️ Database Schema

Collections

Users - Students, Mentors, Admins
Drives - Project drive configurations
Groups - Student groups with members
Synopsis - Project proposals
CheckpointSubmissions - Progress submissions
Evaluations - Mentor evaluations
Results - Final consolidated results
Notifications - System notifications

Detailed schema in database/SCHEMA.md

🔐 User Roles

Role	Permissions
Admin	Create drives, manage all groups, allot mentors, publish results
Mentor	View assigned groups, review synopsis, evaluate checkpoints
Student	Create/join groups, submit synopsis & checkpoints, view results

🛠️ Development

Environment Variables

PORT=5000
NODE_ENV=development
MONGODB_URI=mongodb+srv://...
JWT_SECRET=your_secret_key
JWT_EXPIRE=30d
FRONTEND_URL=http://localhost:3000
MAX_FILE_SIZE=10485760

Run in Development

cd backend
npm run dev  # Auto-reload with nodemon

Run in Production

cd backend
npm start

🧪 Testing

Manual Testing with curl

# Register
curl -X POST http://localhost:5000/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"name":"Test","email":"test@test.com","password":"test123","role":"student","batch":"2025"}'

# Login
curl -X POST http://localhost:5000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"test@test.com","password":"test123"}'

# Use Postman for easier testing

🚧 Roadmap

🤝 Contributing

Contributions are welcome! Please:

Fork the repository
Create a feature branch
Commit your changes
Push to the branch
Open a Pull Request

📝 License

This project is licensed under the terms included in the LICENSE file.

👥 Authors

Ankit Singh - @ankitsingh015

🙏 Acknowledgments

MongoDB Atlas for database hosting
Express.js community
All contributors and testers

📞 Support

For issues, questions, or suggestions:

Open an issue on GitHub
Check documentation in /database and /backend
Review MongoDB Atlas and Express.js documentation

Made with ❤️ for efficient campus project management

Name		Name	Last commit message	Last commit date
backend		backend
dashboard		dashboard
BUSINESS_OVERVIEW.md		BUSINESS_OVERVIEW.md
BUSINESS_REFERENCE.md		BUSINESS_REFERENCE.md
DOCUMENTATION_INDEX.md		DOCUMENTATION_INDEX.md
EMAIL_REALTIME_GUIDE.md		EMAIL_REALTIME_GUIDE.md
IMPLEMENTATION_STATUS.md		IMPLEMENTATION_STATUS.md
LICENSE		LICENSE
PROJECT_SUMMARY.md		PROJECT_SUMMARY.md
README.md		README.md
STAGE_5_IMPLEMENTATION.md		STAGE_5_IMPLEMENTATION.md
SYNOPSIS_GUIDE.md		SYNOPSIS_GUIDE.md
WORKFLOW_GUIDE.md		WORKFLOW_GUIDE.md
package-lock.json		package-lock.json

Latest commit

History

Folders and files

Repository files navigation