Skip to content

NITRR-Official/CampusOS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CampusOS

License: MIT PRs Welcome

The Operating System for Campus Management β€” A modular, scalable platform for managing the complete lifecycle of campus activities.


πŸ“– About

CampusOS is an open-source campus management platform designed to replace fragmented tools like WhatsApp groups, Google Sheets, and email for coordinating campus activities.

Instead of building "just another event management tool," CampusOS provides the complete infrastructure layer for campus ecosystems, handling everything from organizational structure to operations to growth.

Key Problems Solved

  • Coordination Chaos β€” Centralized platform replacing scattered WhatsApp groups
  • Manual Operations β€” Automated workflows for event management and logistics
  • Data Fragmentation β€” Single source of truth for all campus activities
  • Vendor Management β€” Streamlined vendor and resource coordination
  • Analytics Gap β€” Comprehensive insights into campus activity health

Who Is This For?

  • Club Organizers β€” Easy event planning and coordination
  • Event Managers β€” Streamlined check-in, RSVP, and logistics tracking
  • Institute Administrators β€” Complete visibility into campus activities
  • Sponsors β€” Measurable campaign performance and ROI tracking
  • Developers β€” Clean, modular architecture for contributions

✨ Features

Phase 1: Foundation (In Progress)

  • βœ… Modular Architecture β€” Pluggable modules for easy scaling
  • βœ… Authentication β€” JWT-based secure auth system
  • βœ… User Management β€” User profiles and role management
  • βœ… Club Management β€” Club creation and hierarchy
  • βœ… RBAC β€” Role-based access control

Phase 2: Events

  • 🚧 Event Management β€” Create, edit, and publish events
  • 🚧 RSVP System β€” Registration and attendance tracking
  • 🚧 Check-in β€” Event-day attendance management
  • 🚧 Analytics β€” Event metrics and reporting

Phase 3: Execution

  • πŸ“‹ Task Management β€” Create and assign tasks
  • πŸ“‹ Workflows β€” Track task execution states
  • πŸ“‹ Calendar β€” Schedule and deadline management

Phase 4: Operations

  • πŸ“‹ Vendor Management β€” Vendor coordination and procurement
  • πŸ“‹ Resource Allocation β€” Resource scheduling and management
  • πŸ“‹ Budget Tracking β€” Expense and budget management

Phase 5: Growth

  • πŸ“‹ Sponsorship Management β€” Sponsor tracking and engagement
  • πŸ“‹ Marketing Tools β€” Campaign management and assets
  • πŸ“‹ System Analytics β€” Comprehensive reporting

πŸš€ Quick Start

Prerequisites

  • Node.js v18.0.0 or higher
  • pnpm v8.0.0 or higher
  • MongoDB (local or cloud instance)
  • Git

Installation

# Clone the repository
git clone https://github.com/NITRR-Official/CampusOS.git

# Navigate to project directory
cd CampusOS

# Install root dependencies
npm install

# Install backend dependencies
cd backend && npm install && cd ..

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

# Copy environment template
cp backend/.env.example backend/.env.local
cp frontend/.env.example frontend/.env.local

Configuration

Backend Setup (.env.local)

NODE_ENV=development
PORT=3000
MONGODB_URI=mongodb://localhost:27017/campus-os
JWT_SECRET=your-secret-key

Frontend Setup (.env.local)

NEXT_PUBLIC_API_URL=http://localhost:3000

Running the Project

# Terminal 1: Start Backend (from project root)
cd backend
npm run dev

# Terminal 2: Start Frontend (from project root)
cd frontend
npm run dev

πŸ“š Documentation


πŸ› οΈ Tech Stack

  • Backend: Node.js + Express.js β€” Fast, lightweight server
  • Frontend: Next.js + React β€” Modern, full-stack framework
  • Database: MongoDB β€” Flexible schema for rapid development
  • Architecture: Modular, plugin-based system with dynamic loading

πŸ—οΈ Architecture Highlights

Modular Design

Every feature is a self-contained module in /apps/:

  • Routes, controllers, services, and schemas together
  • No direct module-to-module dependencies
  • Communication via shared services or database

Plugin System

  • Dynamic module loading at startup
  • Enable/disable features per deployment
  • Extensible without core changes

System Layers

  1. Foundation β€” Auth, Users, Clubs, RBAC
  2. Event β€” Events, RSVP, Check-in
  3. Execution β€” Tasks, Workflows, Calendar
  4. Operations β€” Vendors, Resources, Budget
  5. Growth β€” Sponsorship, Marketing
  6. System β€” Notifications, Audit, Analytics

🀝 Contributing

We welcome contributions from everyone!

Quick Links:

Getting Started with Development

  1. Read the docs β€” Start with COPILOT.md
  2. Understand the architecture β€” Check .humanet/
  3. Pick an issue β€” Look for good-first-issue label
  4. Create a feature branch β€” git checkout -b feature/your-feature
  5. Make your changes β€” Follow modular structure
  6. Update documentation β€” Update Humanet if needed
  7. Submit a PR β€” Include description of changes

Code Guidelines

  • Follow modular architecture strictly
  • Keep modules independent
  • Write tests for new features
  • Update Humanet documentation
  • Keep controllers thin, logic in services

πŸ‘₯ Maintainers

This project is maintained by:

  • NITRR Open Source Team β€” Maintained by NIT Raipur

Need help?


🎯 Roadmap

Phase 0: System Initialization βœ…

  • Project structure setup
  • Humanet documentation
  • Architecture decisions

Phase 1: Foundation System (In Progress)

  • Auth module
  • User management
  • Club management
  • RBAC system

Phase 2: Event System

  • Event management
  • RSVP system
  • Check-in system

Phase 3: Execution System

  • Task management
  • Workflow system
  • Calendar management

Phase 4: Operations System

  • Vendor management
  • Resource allocation
  • Budget tracking

Phase 5: Growth System

  • Sponsorship management
  • Marketing tools
  • Analytics

Phase 6: System Maturity

  • Performance optimization
  • Security hardening
  • Production readiness

See Project Board for real-time progress.


πŸ“œ License

This project is licensed under the MIT License β€” see the LICENSE file for details.


πŸ™ Acknowledgments

  • Open Source Community β€” For inspiring modular architecture patterns
  • Campus Ecosystem β€” The problem domain that inspired this project
  • All Contributors β€” Thank you for making this better

πŸ“ž Support


Made with ❀️ by Students-NIT Raipur
CampusOS β€” The Operating System for Campus Management

About

A modular, multi-tenant Campus Operating System for managing the complete lifecycle of campus activities

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors