UniLink – University Resource Management System (URMS)

Capstone Group 15 — Production-grade university resource management platform.

---

🚀 Quick Start

1. Frontend (Next.js)

# Install dependencies
npm install

# Copy environment variables
cp .env.example .env.local
# Fill in NEXT_PUBLIC_API_URL, Firebase config keys

# Start development server
npm run dev
# → http://localhost:3000

2. Backend (Node.js + Express)

cd backend
npm install

# Copy environment variables
cp .env.example .env
# Fill in SUPABASE_URL, SUPABASE_SERVICE_KEY, PORT, etc.

# Start backend
npm run dev
# → http://localhost:5000

---

🏗️ Architecture

Capstone-Group-15---URMS/
├── app/                        # Next.js App Router (frontend)
│   ├── admin/                  # Administrative Controls
│   │   ├── analytics/          # Reporting & Analytics Dashboard
│   │   └── user-management/    # Admin User Console
│   ├── bookings/               # Resource Booking & Scheduling Page
│   ├── dashboard/              # Role-Based Main Dashboards (Admin/Lecturer/Student/Maintenance)
│   ├── explore/                # Resource Catalog Explorer
│   ├── forgot-password/        # Password Recovery Page
│   ├── login/                  # Authentication Sign-In Page
│   ├── maintenance/            # Maintenance Tickets Console
│   ├── notifications/          # Alerts & In-App Notification Center
│   ├── profile/                # User Account Settings
│   ├── register/               # New Account Registration Page
│   ├── resources/              # Resource Registry Page
│   ├── globals.css             # Main styling & CSS variables
│   ├── layout.tsx              # Root HTML wrapper
│   └── page.tsx                # Main home / landing page
├── components/                 # Reusable React UI components
│   ├── charts/                 # Chart.js visualization wrappers
│   ├── dashboard/              # Dashboard sidebar & layouts
│   ├── ui/                     # Generic design-system components (buttons, dropdowns, etc.)
│   ├── BulkImport.tsx          # Excel/CSV resources importer
│   ├── MaintenanceTimeline.tsx # Timeline visualization component
│   ├── Navbar.tsx              # Navigation bar (responsive, auth-integrated)
│   ├── Footer.tsx              # Application footer
│   ├── GlobalSearch.tsx        # Omni search component
│   └── ...                     # Popup Modals (AddResource, EditBooking, etc.)
├── hooks/                      # Custom React hooks
│   └── useIdleTimeout.ts       # Inactivity session monitoring
├── lib/                        # Client-side utility functions & contexts
│   ├── auth-context.tsx        # Firebase Authentication context provider
│   ├── firebase.ts             # Firebase client SDK initialization
│   ├── supabase.ts             # Supabase client SDK initialization & REST helpers
│   ├── apiClient.ts            # Wrapper for Node/Express API requests
│   └── session-utils.ts        # Client session validation helpers
├── backend/                    # Express.js REST API
│   ├── src/                    # Backend Source Files
│   │   ├── config/             # DB configurations & service credentials
│   │   │   ├── db.config.ts       # Legacy MySQL connection pool config
│   │   │   ├── firebase.config.ts # Firebase Admin SDK initialization
│   │   │   └── supabaseClient.ts  # Supabase client initialization (RLS scoped)
│   │   ├── controllers/        # Route logic & controllers (resource, analytics, maintenance)
│   │   ├── db/                 # Database schemas, migrations, & seeding
│   │   │   ├── db.ts              # Canonical DB re-exporter (maps to Supabase)
│   │   │   ├── supabase-schema.sql# PostgreSQL DDL schema definition
│   │   │   └── seed.ts            # Mock data populator script
│   │   ├── middleware/         # Express auth and role validation guards
│   │   ├── models/             # Supabase queries data-access layer
│   │   ├── routes/             # REST route routers
│   │   ├── services/           # Exporters (PDF, Excel, Google Sheets) & Scheduler
│   │   ├── app.ts              # Express application configuration
│   │   └── server.ts           # Server entry point
│   ├── package.json            # Backend dependency configuration
│   └── tsconfig.json           # Backend TypeScript configuration
├── Docs/                       # System module documentation & feature logs
├── public/                     # Static assets (images, logos, etc.)
├── package.json                # Frontend/Root workspace dependencies
└── README.md                   # Project overview & quickstart guide

Stack: Next.js 15 · Node.js + Express · Supabase (PostgreSQL) · Firebase Auth · Recharts · Chart.js

---

🔒 Authentication & Access Control

• Firebase Authentication handles login, registration, and JWT issuance.
• Every backend API route is protected by verifyToken middleware.
• Role-based access: admin routes additionally require requireAdmin middleware.
• Analytics endpoints: admin-only.
• Maintenance tickets: creation open to authenticated users; updates/deletes restricted to admin/maintenance roles.

---

📦 Modules

Maintenance Management

• URL: /maintenance
• Admin backend: GET/POST/PUT/DELETE /api/maintenance-tickets
• Status workflow: OPEN → IN_PROGRESS → COMPLETED
• PDF & Excel export via /api/maintenance-tickets/report/pdf|excel
• See Docs/maintenance-module.md

Reporting & Analytics

• URL: /admin/analytics
• Backend: GET /api/admin/analytics/*
• Overview, Booking, Utilization tabs with Recharts & Chart.js visualizations
• Department filter + custom date range
• Export: PDF, Excel, Google Sheets
• See Docs/analytics-module.md

---

🛠️ Key Scripts

Command	Description
npm run dev	Start Next.js frontend
npm run build	Production bundle
npm run test	Run Jest unit tests
cd backend && npm run dev	Start Express backend
cd backend && npm run build	Compile TypeScript

---

🌍 Environment Variables

Frontend (.env.local)

NEXT_PUBLIC_API_URL=http://localhost:5000
NEXT_PUBLIC_FIREBASE_API_KEY=...
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=...
NEXT_PUBLIC_FIREBASE_PROJECT_ID=...

Backend (backend/.env)

PORT=5000
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_SERVICE_KEY=...
FIREBASE_PROJECT_ID=...
GOOGLE_SERVICE_ACCOUNT_JSON=...   # For Google Sheets export

---

🗄️ Database (Supabase / PostgreSQL)

Key tables used by these modules:

Table	Purpose
maintenance_tickets	Ticket CRUD, status workflow
resources	Resource registry (FK for tickets)
bookings	Used for analytics aggregations
users	Role-based access
report_schedules	Automated report scheduling

---

🎨 Design System

• Colors: Deep Navy (brand-primary) · Cerulean (brand-accent)
• Theme: Full dark/light mode via next-themes + CSS variables in globals.css
• Typography: Inter (Google Fonts)
• Logo: public/urms-logo.png

---

Note

Capstone Group 15 — For support, refer to the Docs folder or the individual module documentation files.