Building Management System (BMS) 🏢

A comprehensive full-stack web application for managing residential societies and apartment complexes. Built with modern technologies and best practices.

---

📋 Table of Contents

• Overview
• Features
• Tech Stack
• Project Structure
• Quick Start
• Development
• Deployment
• Documentation
• Contributing

---

🎯 Overview

The Building Management System (BMS) is a modern, scalable solution for managing residential societies. It provides role-based access control for Admins, Owners, and Tenants, enabling efficient management of buildings, payments, maintenance requests, events, visitors, and staff.

Key Highlights

• 🔐 Secure Authentication with JWT
• 👥 Role-Based Access Control (Admin, Owner, Tenant)
• 💰 Payment Management with invoice generation
• 🔧 Maintenance Tracking with staff assignment
• 📅 Event Management for society activities
• 👷 Staff Management with shift scheduling
• 🚪 Visitor Management with approval workflow
• 📊 Analytics Dashboard with real-time insights

---

✨ Features

For Admins

• Manage buildings, towers, and flats
• Register and verify owners/tenants
• Assign maintenance requests to staff
• Create and manage events
• Approve visitor entries
• Generate payment reports

For Owners

• View owned properties
• Make payments (maintenance, amenities)
• Create maintenance requests
• View payment history
• Manage tenant information

For Tenants

• View lease details
• Make payments
• Create maintenance requests
• Register visitors
• View society events

---

🛠️ Tech Stack

Backend

• Runtime: Node.js with TypeScript
• Framework: Express.js
• Database: MongoDB with Mongoose ODM
• Authentication: JWT + bcrypt
• Validation: Zod
• API Documentation: Swagger/OpenAPI
• Testing: Jest + Supertest
• Email: Resend

Frontend

• Framework: React 19
• Build Tool: Vite
• UI Library: Material-UI (MUI)
• State Management: Zustand + React Query
• Routing: React Router v7
• Forms: React Hook Form + Zod
• Styling: Emotion (CSS-in-JS)
• Charts: Recharts
• Testing: Vitest + React Testing Library

DevOps

• Backend Hosting: Render
• Frontend Hosting: Vercel
• Database: MongoDB Atlas
• Version Control: Git

---

📁 Project Structure

BMS/
├── backend/                 # Express.js backend
│   ├── src/
│   │   ├── config/         # Database, Swagger config
│   │   ├── controllers/    # Route controllers
│   │   ├── middleware/     # Auth, validation, error handling
│   │   ├── models/         # Mongoose schemas
│   │   ├── routes/         # API routes
│   │   ├── services/       # Business logic
│   │   ├── utils/          # Helper functions
│   │   ├── validators/     # Zod schemas
│   │   ├── docs/           # OpenAPI specs
│   │   ├── __tests__/      # Unit & integration tests
│   │   └── server.ts       # Entry point
│   ├── package.json
│   └── tsconfig.json
│
├── frontend/                # React frontend
│   ├── src/
│   │   ├── components/     # Reusable components
│   │   ├── pages/          # Page components
│   │   ├── services/       # API services
│   │   ├── store/          # Zustand stores
│   │   ├── types/          # TypeScript types
│   │   ├── utils/          # Helper functions
│   │   ├── App.tsx         # Root component
│   │   └── main.tsx        # Entry point
│   ├── package.json
│   ├── vite.config.ts
│   └── vercel.json         # Vercel deployment config
│
└── README.md               # This file

---

🚀 Quick Start

Prerequisites

• Node.js >= 18.x
• npm >= 9.x
• MongoDB (local or Atlas)
• Git

Installation

1. Clone the repository

   git clone https://github.com/AnoopG7/BMS.git
   cd BMS

2. Install backend dependencies

   cd backend
   npm install

3. Install frontend dependencies

   cd ../frontend
   npm install

4. Set up environment variables

   Backend (backend/.env):

   NODE_ENV=development
   PORT=3000
   MONGODB_URI=mongodb://localhost:27017/bms
   JWT_SECRET=your_jwt_secret_key_here
   JWT_EXPIRE=7d
   FRONTEND_URL=http://localhost:5173
   RESEND_API_KEY=your_resend_api_key

   Frontend (frontend/.env):

   VITE_API_BASE_URL=http://localhost:3000

5. Seed the database (optional)

   cd backend
   npm run seed

6. Start development servers

   Backend:

   cd backend
   npm run dev

   Frontend:

   cd frontend
   npm run dev

7. Access the application

   • Frontend: http://localhost:5173
   • Backend API: http://localhost:3000
   • API Docs: http://localhost:3000/api-docs

---

💻 Development

Backend Development

cd backend

# Run in development mode
npm run dev

# Run tests
npm run test

# Run tests with coverage
npm run test:coverage

# Build for production
npm run build

# Start production server
npm start

Frontend Development

cd frontend

# Run in development mode
npm run dev

# Run tests
npm run test

# Build for production
npm run build

# Preview production build
npm run preview

Code Quality

# Lint backend
cd backend && npm run lint

# Lint frontend
cd frontend && npm run lint

# Type check
npm run type-check

---

📚 Documentation

• API Documentation: backend/API_DOCUMENTATION.md
• API Endpoints: backend/API_ENDPOINTS.md
• Swagger UI: Available at /api-docs when running backend
• Backend README: backend/README.md
• Frontend README: frontend/README.md

---

🧪 Testing

Backend Tests

cd backend

# Run all tests
npm run test

# Run unit tests only
npm run test:unit

# Run integration tests only
npm run test:integration

# Watch mode
npm run test:watch

# Coverage report
npm run test:coverage

Test Coverage: 227 tests passing across unit and integration suites.

Frontend Tests

cd frontend

# Run tests
npm run test

# Run with UI
npm run test:ui

# Coverage report
npm run test:coverage

---

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Coding Standards

• Follow TypeScript best practices
• Write tests for new features
• Maintain consistent code formatting
• Update documentation as needed

---

📄 Copyright & License

Copyright © 2025 Anoop Gupta. All Rights Reserved.

This source code is the exclusive property of Anoop Gupta. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without explicit written permission from the author.

---

👨‍💻 Author

Anoop Gupta

---

🙏 Acknowledgments

• Built with modern web technologies
• Inspired by real-world building management needs
• Designed for scalability and maintainability

---

Happy Coding! 🚀