Aubin Maga

Hotel Property Management System (PMS) A modern, scalable, and professional Hotel Property Management System built with React, TypeScript, Node.js, Express, and PostgreSQL. ## ✨ Features ### 🔐 Authentication & Authorization - JWT-based secure authentication - Role-based access control (Admin, Manager, Receptionist) - Protected routes and API endpoints ### 📊 Premium Dashboard - Real-time statistics (bookings, revenue, occupancy) - Interactive charts (Recharts) - Booking trends (line chart) - Revenue analytics (bar chart) - Room occupancy (pie chart) - Recent activities feed - Responsive and modern design ### 🛏️ Room Management - Add, edit, delete rooms - Room types (Single, Double, Suite) - Room status tracking (Available, Occupied, Maintenance) - Pricing management ### 📅 Booking System - Create and manage reservations - Check-in / Check-out functionality - Booking status tracking - Guest information management ### 👤 Guest Management - Store guest details - Booking history - Contact information ### 💳 Payments & Billing - Payment tracking - Multiple payment methods - Invoice generation - Financial reports ### 🔔 Notifications - Real-time alerts - Booking notifications - Payment confirmations ### 👨‍💼 Staff Management - User management - Role assignment - Activity logs ## 🎨 Design System ### Color Palette - **Seafoam Teal** (#20B2AA) - Primary - **Grey Brown** (#8B7D6B) - Secondary - **Yellow Gold** (#FFD700) - Accent - **Mint Light** (#F0FFF4) - Background ### UI Features - Modern SaaS-style dashboard - Collapsible sidebar navigation - Dark mode support - Smooth animations (Framer Motion) - Fully responsive design - Card-based layout with shadows ## 🛠️ Tech Stack ### Frontend - React 18 with TypeScript - Vite (build tool) - Tailwind CSS (styling) - Framer Motion (animations) - Recharts (data visualization) - React Query (data fetching) - Zustand (state management) - React Router (routing) - Axios (HTTP client) ### Backend - Node.js with Express - TypeScript - PostgreSQL (database) - JWT (authentication) - Bcrypt (password hashing) - Helmet (security) - Morgan (logging) ## 📁 Project Structure ``` hotel-pms/ ├── client/ # React Frontend │ ├── src/ │ │ ├── components/ │ │ │ ├── ui/ # Reusable UI components │ │ │ ├── layout/ # Layout components │ │ │ └── dashboard/ # Dashboard widgets │ │ ├── pages/ # Page components │ │ ├── services/ # API services │ │ ├── store/ # State management │ │ ├── types/ # TypeScript types │ │ └── App.tsx │ └── package.json │ ├── server/ # Node.js Backend │ ├── src/ │ │ ├── config/ # Configuration │ │ ├── controllers/ # Route handlers │ │ ├── middleware/ # Auth, validation │ │ ├── routes/ # API routes │ │ └── server.ts │ └── package.json │ └── database/ ├── schema.sql # Database schema └── seed.sql # Sample data ``` ## 🚀 Getting Started ### Prerequisites - Node.js (v18 or higher) - PostgreSQL (v14 or higher) - npm or yarn ### 1. Database Setup ```bash # Create database createdb hotel_pms # Run schema psql -d hotel_pms -f database/schema.sql # Seed sample data psql -d hotel_pms -f database/seed.sql ``` ### 2. Backend Setup ```bash cd server # Install dependencies npm install # Create .env file cp .env.example .env # Update .env with your database credentials # DB_HOST=localhost # DB_PORT=5432 # DB_NAME=hotel_pms # DB_USER=postgres # DB_PASSWORD=your_password # JWT_SECRET=your_secret_key # Run development server npm run dev ``` The backend will run on `http://localhost:5000` ### 3. Frontend Setup ```bash cd client # Install dependencies npm install # Run development server npm run dev ``` The frontend will run on `http://localhost:5173` ## Demo Credentials ``` Admin: Email: ****@**** Password: password123 Manager: Email: ****@**** Password: password123 Receptionist: Email: ****@**** Password: password123 ``` ## API Endpoints ### Authentication - `POST /api/auth/login` - User login - `GET /api/auth/profile` - Get user profile ### Dashboard - `GET /api/dashboard/stats` - Dashboard statistics - `GET /api/dashboard/booking-trends` - Booking trends - `GET /api/dashboard/revenue-analytics` - Revenue data - `GET /api/dashboard/recent-activities` - Recent activities ### Rooms - `GET /api/rooms` - Get all rooms - `POST /api/rooms` - Create room (Admin/Manager) - `PUT /api/rooms/:id` - Update room (Admin/Manager) - `DELETE /api/rooms/:id` - Delete room (Admin) ### Bookings - `GET /api/bookings` - Get all bookings - `POST /api/bookings` - Create booking - `PATCH /api/bookings/:id/status` - Update booking status ### Guests - `GET /api/guests` - Get all guests - `POST /api/guests` - Create guest - `GET /api/guests/:id/bookings` - Get guest booking history ## Security Features - JWT-based authentication - Password hashing with bcrypt - Role-based access control - SQL injection prevention - CORS configuration - Helmet security headers - Input validation ## Future Enhancements - [ ] Multi-hotel support (SaaS-ready) - [ ] Export reports (PDF/Excel) - [ ] Email notifications - [ ] SMS integration - [ ] Online booking portal - [ ] Housekeeping management - [ ] Inventory management - [ ] Advanced analytics - [ ] Mobile app ## License MIT License - feel free to use this project for your own purposes. ## Contributing Contributions are welcome! Please feel free to submit a Pull Request. ## Support For support, email ****@**** or open an issue in the repository. --- Built with using React, TypeScript, Node.js, and PostgreSQL # zenith1 ## 🚀 Deployment ### Vercel Deployment This project is configured for easy deployment on Vercel: 1.