Nazamly 🎓

A comprehensive MERN Stack University Campus Management System
Built for the German University in Cairo (GUC)

📋 Table of Contents

Overview
Features
Tech Stack
User Roles
Project Structure
Getting Started
Environment Variables
API Overview
Documentation
Scripts
Contributors

🎯 Overview

Nazamly is a full-stack web application designed to streamline campus activities and event management at the German University in Cairo. The platform serves multiple user types including students, staff, professors, vendors, and administrators, providing a centralized hub for:

📅 Event Management - Create, discover, and register for university events
🏋️ Gym Sessions - Schedule and book gym classes
🏀 Sports Courts - Reserve basketball, tennis, and football courts
🏪 Vendor Services - Booth applications for bazaars and loyalty programs
📊 Polling System - Create and participate in campus polls
💳 Integrated Payments - Wallet system with Stripe integration

✨ Features

🎪 Events Module

Multiple event types: Workshops, Trips, Bazaars, Conferences
Event registration with payment support (Wallet/Stripe)
QR code generation for external visitors
Event ratings, comments, and favorites
Attendance certificates (PDF generation)
Excel export of registrations

🏋️ Gym Module

Gym session scheduling and management
Multiple session types
User registration and capacity management

🏟️ Courts Module

Sports court management (Basketball, Tennis, Football)
Real-time slot availability checking
Court reservation system

🏪 Vendor Module

Booth applications for bazaars
Document uploads (tax cards, company logos)
Loyalty program applications
Payment processing for booth fees

📊 Polling & Voting

Poll creation by Events Office
Secure voting system
Results visualization

💰 Wallet & Payments

User wallet balance management
Stripe integration for card payments
Transaction history
Refund processing (14-day policy)

🔔 Notifications

In-app notification system
Event reminders via cron jobs
Email notifications

📈 Reporting

Attendance reports
Sales analytics
Export to Excel functionality

🛠️ Tech Stack

Backend

Technology	Version	Purpose
Node.js	16.x+	Runtime environment
Express.js	5.1.0	Web framework
MongoDB	7.0.0	Database (via Mongoose 8.19.0)
JWT	9.0.2	Authentication
bcrypt	6.0.0	Password hashing
Cloudinary	1.41.3	File/image storage
Stripe	20.0.0	Payment processing
nodemailer	6.10.1	Email service
qrcode	1.5.4	QR code generation
pdfkit	0.17.2	PDF generation (certificates)
xlsx	0.18.5	Excel export
node-cron	4.2.1	Scheduled tasks
helmet	7.1.0	Security headers
Joi	17.11.0	Validation

Frontend

Technology	Version	Purpose
React	18.2.0	UI library
Vite	7.1.7	Build tool & dev server
React Router DOM	6.20.1	Client-side routing
TailwindCSS	3.4.18	Utility-first styling
Axios	1.6.2	HTTP client
Framer Motion	10.18.0	Animations
React Hook Form	7.49.2	Form handling
Zod	3.22.4	Schema validation
Stripe React	5.4.1	Payment UI components
Leaflet	1.9.4	Interactive maps
Lucide React	-	Icon library

👥 User Roles

Role	Description	Email Domain
Student	University students	`@student.guc.edu.eg`
Staff	University staff members	`@guc.edu.eg`
TA	Teaching assistants	Admin assigned
Professor	Professors, can create workshops	Admin assigned
Vendor	External companies for bazaars	Any email
Admin	System administrators	Admin created
EventOffice	Events office staff	Admin assigned

📁 Project Structure

Nazamly/
├── 📄 package.json              # Root workspace configuration
├── 📄 README.md                 # Project documentation
├── 📄 ATTENDANCE_REPORT_FEATURE.md
│
├── 📂 backend/
│   ├── 📄 package.json
│   ├── 📄 README.md             # Backend setup guide
│   ├── 📄 PAYMENT_SYSTEM_SUMMARY.md
│   ├── 📄 VENDOR_DOCUMENTS_SETUP.md
│   ├── 📄 CLOUDINARY_SETUP.md
│   ├── 📂 docs/
│   │   ├── API.md               # Complete API documentation
│   │   ├── DATA_MODEL.md        # Database schema docs
│   │   └── VENDOR_PAYMENT_FLOW.md
│   ├── 📂 src/
│   │   ├── app.js               # Express app configuration
│   │   ├── server.js            # Server entry point
│   │   ├── 📂 config/           # Database, Cloudinary, validation
│   │   ├── 📂 constants/        # Roles, statuses, schedules
│   │   ├── 📂 controllers/      # Route handlers (18 controllers)
│   │   ├── 📂 middleware/       # Auth & upload middleware
│   │   ├── 📂 models/           # Mongoose schemas (17 models)
│   │   ├── 📂 routes/           # API route definitions
│   │   ├── 📂 services/         # Business logic layer
│   │   ├── 📂 validators/       # Input validation schemas
│   │   └── 📂 utils/            # Utility functions
│   └── 📂 tools/                # Admin & seed scripts
│
└── 📂 frontend/
    ├── 📄 package.json
    ├── 📄 index.html
    ├── 📄 vite.config.js
    ├── 📄 tailwind.config.js
    ├── 📂 docs/                 # Frontend theming guides
    ├── 📂 public/               # Static assets
    └── 📂 src/
        ├── App.jsx              # Main app component
        ├── main.jsx             # Entry point
        ├── index.css            # Global styles (Tailwind)
        ├── 📂 components/       # Reusable UI components
        │   ├── Admin/
        │   ├── auth/
        │   ├── events/
        │   ├── EventsOffice/
        │   └── landing/
        ├── 📂 pages/            # Page components
        │   ├── Admin/
        │   ├── Events/
        │   ├── EventsOffice/
        │   ├── Login/
        │   └── Signup/
        ├── 📂 services/         # API service layer
        ├── 📂 hooks/            # Custom React hooks
        └── 📂 utils/            # Utility functions

🚀 Getting Started

Prerequisites

Node.js 16.x or higher
MongoDB 5.x+ (local installation or MongoDB Atlas)
npm or yarn package manager
Git

Installation

Clone the repository

git clone https://github.com/Advanced-Computer-Lab-2025/Nazamly.git
cd Nazamly

Install all dependencies

# Install root, frontend, and backend dependencies
npm run install:all

Or install manually:

npm install
cd frontend && npm install
cd ../backend && npm install

Set up environment variables

Create a .env file in the backend/ directory (see Environment Variables)
Start MongoDB

Ensure MongoDB is running locally or configure your MongoDB Atlas connection string

Run the application

# Development mode (runs both backend and frontend)
npm run dev

Running Separately

# Backend only (runs on port 5000)
npm run dev:backend

# Frontend only (runs on port 5173)
npm run dev:frontend

Production Build

# Build frontend for production
npm run build

# Start production server
npm run start:backend

🔐 Environment Variables

Create a .env file in the backend/ directory with the following variables:

# ═══════════════════════════════════════════════════════════════
# DATABASE
# ═══════════════════════════════════════════════════════════════
MONGO_URL=mongodb+srv://<username>:<password>@cluster.mongodb.net/nazamly

# ═══════════════════════════════════════════════════════════════
# SERVER
# ═══════════════════════════════════════════════════════════════
PORT=5000
NODE_ENV=development
CLIENT_URL=http://localhost:5173

# ═══════════════════════════════════════════════════════════════
# AUTHENTICATION (JWT)
# ═══════════════════════════════════════════════════════════════
JWT_SECRET=your-super-secret-jwt-key
JWT_EXPIRES_IN=1h
JWT_REMEMBER_ME_EXPIRES_IN=30d

# ═══════════════════════════════════════════════════════════════
# EMAIL VALIDATION
# ═══════════════════════════════════════════════════════════════
PASSWORD_MIN_LENGTH=8
PASSWORD_MAX_LENGTH=128
STUDENT_EMAIL_DOMAIN=@student.guc.edu.eg
STAFF_EMAIL_DOMAIN=@guc.edu.eg

# ═══════════════════════════════════════════════════════════════
# CLOUDINARY (File Uploads)
# ═══════════════════════════════════════════════════════════════
CLOUDINARY_CLOUD_NAME=your-cloud-name
CLOUDINARY_API_KEY=your-api-key
CLOUDINARY_API_SECRET=your-api-secret
MAX_FILE_SIZE_MB=5

# ═══════════════════════════════════════════════════════════════
# STRIPE (Payments)
# ═══════════════════════════════════════════════════════════════
STRIPE_SECRET_KEY=sk_test_xxx
STRIPE_PUBLISHABLE_KEY=pk_test_xxx
STRIPE_WEBHOOK_SECRET=whsec_xxx
STRIPE_CURRENCY=egp

# ═══════════════════════════════════════════════════════════════
# RATE LIMITING
# ═══════════════════════════════════════════════════════════════
RATE_LIMIT_WINDOW_MS=900000
RATE_LIMIT_MAX_REQUESTS=100

# ═══════════════════════════════════════════════════════════════
# EMAIL (SMTP) - Optional
# ═══════════════════════════════════════════════════════════════
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@gmail.com
SMTP_PASSWORD=your-app-password

🔌 API Overview

The backend exposes a RESTful API. Here's an overview of the main endpoint categories:

Authentication `/api/auth`

Method	Endpoint	Description
POST	`/signup`	User registration
POST	`/login`	User login
POST	`/logout`	User logout
GET	`/verify-email/:token`	Email verification

Events `/api/events`

Method	Endpoint	Description
GET	`/`	Get all events
POST	`/`	Create event
GET	`/:eventId`	Get event by ID
PATCH	`/:eventId/archive`	Archive event
POST	`/:eventId/qr`	Generate QR code
GET	`/:eventId/export`	Export registrations

Registrations `/api/registrations`

Method	Endpoint	Description
POST	`/:eventId/register`	Register for event
DELETE	`/:eventId/cancel`	Cancel registration
GET	`/my-registrations`	User's registrations
POST	`/:eventId/rate`	Rate an event

Gym `/api/gym`

Method	Endpoint	Description
GET	`/sessions`	Get gym sessions
POST	`/sessions`	Create session
POST	`/sessions/:sessionId/register`	Register for session

Courts `/api/courts`

Method	Endpoint	Description
GET	`/`	Get all courts
GET	`/:courtId/available-slots`	Get available slots
POST	`/:courtId/reserve`	Reserve court

Vendor `/api/vendors`

Method	Endpoint	Description
GET	`/bazaars`	Get upcoming bazaars
POST	`/applications`	Apply for booth
POST	`/loyalty-program/apply`	Apply to loyalty program

Admin `/api/admin`

Method	Endpoint	Description
GET	`/signup-requests`	View signup requests
PATCH	`/signup-requests/:id`	Approve/reject requests
PATCH	`/users/:userId/block`	Block/unblock user

Payments `/api/payments`

Method	Endpoint	Description
POST	`/stripe/create-intent`	Create payment intent
POST	`/stripe/finalize`	Finalize payment

📖 For complete API documentation, see backend/docs/API.md

📚 Documentation

Document	Location	Description
Backend README	`backend/README.md`	Backend setup guide
API Documentation	`backend/docs/API.md`	Complete API reference
Data Models	`backend/docs/DATA_MODEL.md`	MongoDB schema docs
Vendor Payment Flow	`backend/docs/VENDOR_PAYMENT_FLOW.md`	Payment workflow
Payment System	`backend/PAYMENT_SYSTEM_SUMMARY.md`	Payment implementation
Cloudinary Setup	`backend/CLOUDINARY_SETUP.md`	Image upload config
Frontend Theming	`frontend/docs/`	Theme and font guides

📜 Scripts

Root Level

Script	Command	Description
`dev`	`npm run dev`	Run both backend and frontend
`dev:backend`	`npm run dev:backend`	Run backend with nodemon
`dev:frontend`	`npm run dev:frontend`	Run Vite dev server
`build`	`npm run build`	Build frontend for production
`install:all`	`npm run install:all`	Install all dependencies

Backend Tools

# Create admin user
node backend/tools/create_admin_user.js

# Create test user
node backend/tools/create_test_user.js

# Seed courts data
node backend/tools/seed_courts.js

👨‍💻 Contributors

This project was developed as part of the Advanced Computer Lab course at the German University in Cairo (GUC).

📄 License

This project is developed for educational purposes as part of the GUC curriculum.

Made with ❤️ at German University in Cairo

Name		Name	Last commit message	Last commit date
.vscode		.vscode
backend		backend
frontend		frontend
.DS_Store		.DS_Store
.gitignore		.gitignore
ATTENDANCE_REPORT_FEATURE.md		ATTENDANCE_REPORT_FEATURE.md
README.md		README.md
REWARD_POINTS_BACKEND_IMPLEMENTATION.md		REWARD_POINTS_BACKEND_IMPLEMENTATION.md
REWARD_POINTS_SESSION_START_SETUP.md		REWARD_POINTS_SESSION_START_SETUP.md
WAITLIST_FEATURE.md		WAITLIST_FEATURE.md
package-lock.json		package-lock.json
package.json		package.json

Latest commit

History

Folders and files

Repository files navigation

Nazamly 🎓

📋 Table of Contents

🎯 Overview

✨ Features

🎪 Events Module

🏋️ Gym Module

🏟️ Courts Module

🏪 Vendor Module

📊 Polling & Voting

💰 Wallet & Payments

🔔 Notifications

📈 Reporting

🛠️ Tech Stack

Backend

Frontend

👥 User Roles

📁 Project Structure

🚀 Getting Started

Prerequisites

Installation

Running Separately

Production Build

🔐 Environment Variables

🔌 API Overview

Authentication /api/auth

Events /api/events

Registrations /api/registrations

Gym /api/gym

Courts /api/courts

Vendor /api/vendors

Admin /api/admin

Payments /api/payments

📚 Documentation

📜 Scripts

Root Level

Backend Tools

👨‍💻 Contributors

📄 License

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages