https://github.com/red2n/home
This project is to study and show up the skills that i Learn/Possess and how i have implemented those in this project. this also shows my learning ability and adaptability with new technologies.
https://github.com/red2n/home
angular4 docker docker-compose java microservices postgresql spring-boot spring-cloud
Last synced: 4 months ago
JSON representation
This project is to study and show up the skills that i Learn/Possess and how i have implemented those in this project. this also shows my learning ability and adaptability with new technologies.
- Host: GitHub
- URL: https://github.com/red2n/home
- Owner: red2n
- License: gpl-3.0
- Created: 2023-04-14T05:04:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-18T11:27:43.000Z (12 months ago)
- Last Synced: 2025-07-18T14:35:11.957Z (12 months ago)
- Topics: angular4, docker, docker-compose, java, microservices, postgresql, spring-boot, spring-cloud
- Language: PLpgSQL
- Homepage: https://www.navinkumar.net/
- Size: 1.04 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Property Management System (PMS)
## 1. System Architecture Overview
1. System Architecture Overview
Based on the UML model we've developed, I propose a modern, cloud-native, microservices-based architecture for the PMS. This approach will allow for better scalability, maintainability, and the ability to deploy updates to individual components without affecting the entire system.
### 1.1 High-Level Architecture
```
┌─────────────────────────────────────────────────────────────┐
│ Client Applications │
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
│ │ Web │ │ Mobile │ │Self-Service│ │ Partner │ │
│ │ App │ │ App │ │ Kiosk │ │ APIs │ │
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
└───────────────────────────┬─────────────────────────────────┘
│
┌───────────────────────────▼─────────────────────────────────┐
│ API Gateway │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ Authentication │ Rate Limiting │ Routing │ │
│ └───────────────────────────────────────────────────────┘ │
└───────────────────────────┬─────────────────────────────────┘
│
┌───────────────────────────▼─────────────────────────────────┐
│ Service Mesh / Message Bus │
└───────────┬────────────┬────────────┬────────────┬──────────┘
│ │ │ │
┌───────────▼───┐ ┌──────▼───────┐ ┌──▼───────────┐ ┌─────▼────────┐
│ Core Services │ │Guest Services│ │Booking Engine│ │Financial Svcs│
└───────────────┘ └──────────────┘ └──────────────┘ └──────────────┘
│ │ │ │
┌───────────▼───┐ ┌──────▼───────┐ ┌──▼───────────┐ ┌─────▼────────┐
│ Inventory Mgmt │ │Rate & Offers │ │Communications│ │ Reporting │
└───────────────┘ └──────────────┘ └──────────────┘ └──────────────┘
│ │ │ │
┌───────────▼───┐ ┌──────▼───────┐ ┌──▼───────────┐ ┌─────▼────────┐
│ Integration │ │ Audit System │ │ Tax Engine │ │Housekeeping │
└───────────────┘ └──────────────┘ └──────────────┘ └──────────────┘
│ │ │ │
┌───────────▼────────────▼────────────▼────────────▼──────────────┐
│ Data Services Layer │
│ ┌────────────┐ ┌────────────┐ ┌────────────┐ ┌────────────┐ │
│ │ Relational │ │ Document │ │ Cache │ │ Search │ │
│ │ Database │ │ Store │ │ Service │ │ Engine │ │
│ └────────────┘ └────────────┘ └────────────┘ └────────────┘ │
└─────────────────────────────────────────────────────────────────┘
```
## 2. Technology Stack Recommendations
### 2.1 Backend Services
- Programming Language: Java/Spring Boot for core services, Node.js for lightweight services
API Design: REST for synchronous operations, gRPC for service-to-service communication
- Message Broker: Apache Kafka for event streaming
- Service Mesh: Istio for service discovery, load balancing, and circuit breaking
### 2.2 Data Persistence
- Primary Database: PostgreSQL for relational data (transactions, bookings, financial records)
- Document Store: MongoDB for flexible schemas (guest preferences, reporting data)
- Cache: Redis for session management and frequently accessed data
- Search: Elasticsearch for advanced search capabilities across inventory and guest data
### 2.3 Frontend
- Web Application: React.js with TypeScript for staff portal
- Mobile Applications: React Native for cross-platform mobile support
- Design System: Custom component library with consistent styling
### 2.4 DevOps & Infrastructure
- Containerization: Docker
- Orchestration: Kubernetes
- CI/CD: Jenkins or GitHub Actions
- Monitoring: Prometheus, Grafana, and ELK stack
- Cloud Provider: AWS or Azure
## 3. Microservices Breakdown
Based on the UML model, the system will be organized into the following microservices:
### 3.1 Core Services
#### 3.1.1 Identity & Access Management Service
- User authentication and authorization
- Role-based access control
- Department management
- Session management
- Integration with SSO providers
#### 3.1.2 Property Configuration Service
- Property management
- Property type configuration
- Global settings management
### 3.2 Inventory Management
#### 3.2.1 Room Inventory Service
- Room type management
- Room status tracking
- Amenity management
- Room availability calendar
#### 3.2.2 Housekeeping Service
- Task assignment and scheduling
- Room status updates
- Maintenance request handling
- Mobile app integration for housekeeping staff
### 3.3 Guest Services
#### 3.3.1 Guest Profile Service
- Guest data management
- Preferences tracking
- Profile merging and deduplication
- GDPR compliance tools
#### 3.3.2 Loyalty Service
- Points management
- Tier calculations
- Redemption processing
- Partner program integration
### 3.4 Rate Management
#### 3.4.1 Rate Plan Service
- Rate plan configuration
- Seasonal rate management
- BAR (Best Available Rate) calculations
- Rate restrictions management
#### 3.4.2 Package Service
- Package creation and management
- Add-on bundling
- Package availability rules
#### 3.4.3 Cancellation Policy Service
- Policy configuration
- Rule management
- Fee calculation
- Cancellation enforcement
### 3.5 Offer Management
#### 3.5.1 Offer Definition Service
- Offer type management
- Department authorization mapping
- Offer creation and configuration
- Approval workflow management
#### 3.5.2 Offer Application Service
- Offer eligibility checking
- Discount calculation
- Usage tracking
- Offer selection optimization
### 3.6 Booking Engine
#### 3.6.1 Reservation Service
- Booking creation and management
- Modification handling
- Cancellation processing
- Room assignment
- Channel management
- Check-in/check-out processing
#### 3.6.2 Availability Calculation Service
- Real-time inventory checking
- Rate availability
- Restriction enforcement
- Overbooking management
### 3.7 Financial Services
#### 3.7.1 Folio Management Service
- Guest bill management
- Charge posting
- Split folio handling
- Bill presentation
#### 3.7.2 Payment Processing Service
- Payment method handling
- Transaction processing
- Refund management
- Payment gateway integration
- Tokenization for PCI compliance
#### 3.7.3 Ledger Service
- Account management
- Transaction posting
- Balance calculations
- Reconciliation tools
- Fiscal period management
#### 3.7.4 Night Audit Service
- Daily closing procedures
- Automatic charge posting
- Error checking
- Report generation
### 3.8 Taxation
#### 3.8.1 Tax Configuration Service
- Tax rule management
- Tax group configuration
- Jurisdiction management
#### 3.8.2 Tax Calculation Service
- Real-time tax calculations
- Tax exemption handling
- Tax reporting
### 3.9 Communications & Reporting
#### 3.9.1 Notification Service
- Template management
- Multi-channel delivery (email, SMS)
- Scheduling and triggers
- Delivery tracking
#### 3.9.2 Reporting Service
- Standard report generation
- Custom report builder
- Data visualization
- Export capabilities
- Scheduled report delivery
### 3.10 Audit & Logging
#### 3.10.1 Audit Trail Service
- Change tracking across all entities
- User action logging
- Compliance reporting
- Data immutability
## 4. Data Flow Diagrams
### 4.1 Booking Creation Flow
```
┌──────────┐ ┌─────────────┐ ┌───────────────┐ ┌──────────────┐
│ Client │────▶│ Reservation │────▶│ Availability │────▶│ Rate │
│ App │ │ Service │ │ Service │ │ Service │
└──────────┘ └─────────────┘ └───────────────┘ └──────────────┘
│ │
▼ ▼
┌─────────────┐ ┌──────────────┐
│ Guest │ │ Offer │
│ Service │ │ Service │
└─────────────┘ └──────────────┘
│ │
▼ ▼
┌─────────────┐ ┌───────────────┐ ┌──────────────┐
│ Folio │────▶│ Tax │────▶│ Payment │
│ Service │ │ Service │ │ Service │
└─────────────┘ └───────────────┘ └──────────────┘
│ │
▼ ▼
┌─────────────┐ ┌──────────────┐
│ Ledger │ │ Notification │
│ Service │ │ Service │
└─────────────┘ └──────────────┘
│ │
▼ ▼
┌─────────────┐ ┌──────────────┐
│ Audit │ │ Inventory │
│ Service │ │ Service │
└─────────────┘ └──────────────┘
```
### 4.2 Offer Approval Flow
```
┌──────────┐ ┌─────────────┐ ┌───────────────┐
│ Staff │────▶│ Offer │────▶│ Department │
│ Portal │ │ Service │ │ Service │
└──────────┘ └─────────────┘ └───────────────┘
│ │
▼ ▼
┌─────────────┐ ┌───────────────┐
│ Notification│────▶│ Manager │
│ Service │ │ Portal │
└─────────────┘ └───────────────┘
│
▼
┌───────────────┐
│ Offer │
│ Service │
└───────────────┘
│
▼
┌───────────────┐
│ Audit │
│ Service │
└───────────────┘
```
## 5. Database Schema Design
The database design will follow a hybrid approach:
### 5.1 Core Transactional Database (PostgreSQL)
- Schema for each major domain (booking, guest, financial, inventory)
- Strong referential integrity for critical financial data
- Partitioning by property and date for performance
### 5.2 Document Store (MongoDB)
- Guest preferences and history
- Flexible attributes for rooms and properties
- Report data and templates
### 5.3 Search Index (Elasticsearch)
- Room and rate search
- Guest search
- Full-text search across documents
### 5.4 Cache Layer (Redis)
- Session data
- Frequently accessed configuration
- Rate availability cache
- Inventory status
## 6. Integration Architecture
### 6.1 External System Integration
```
┌─────────────────────────────────────────────────────────────┐
│ PMS Core │
└─────────────────────────────┬───────────────────────────────┘
│
┌─────────────────────────────▼───────────────────────────────┐
│ Integration Layer │
│ ┌────────────┐ ┌────────────┐ ┌────────────┐ │
│ │ API │ │ Event │ │ File │ │
│ │ Gateway │ │ Bus │ │ Exchange │ │
│ └────────────┘ └────────────┘ └────────────┘ │
└───────┬─────────────────┬──────────────────┬────────────────┘
│ │ │
┌───────▼─────┐ ┌───────▼─────┐ ┌───────▼─────┐
│ Channel │ │ Payment │ │ Accounting │
│ Managers │ │ Gateways │ │ System │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
┌───────▼─────┐ ┌───────▼─────┐ ┌───────▼─────┐
│ OTA │ │ CRM │ │ Revenue │
│ Platforms │ │ Systems │ │ Management │
└─────────────┘ └─────────────┘ └─────────────┘
```
### 6.2 Integration Methods
- **RESTful APIs:** For synchronous, request-response interactions
- **Webhooks:** For external systems to notify PMS of events
- **Message Queue:** For asynchronous, event-driven communication
- **Batch Processing:** For high-volume data exchange during off-peak hours
## 7. Security Architecture
### 7.1 Authentication & Authorization
- OAuth 2.0 / OpenID Connect for authentication
- JWT tokens for session management
- Role-Based Access Control (RBAC)
- Attribute-Based Access Control (ABAC) for fine-grained permissions
- Department-based access restrictions
### 7.2 Data Protection
- Data encryption at rest
- TLS for all communications
- PCI DSS compliance for payment handling
- Tokenization for sensitive data
- Key rotation policies
### 7.3 Audit & Compliance
- Comprehensive audit logging
- Immutable audit records
- GDPR compliance tools
- Data retention policies
## 8. Scalability & High Availability
### 8.1 Horizontal Scaling
- Stateless services for easy scaling
- Database read replicas for query scaling
- Sharding strategy for multi-property deployments
### 8.2 High Availability
- Multi-AZ deployment
- Database clustering
- Service redundancy
- Automated failover
### 8.3 Disaster Recovery
- Regular backups
- Point-in-time recovery
- Cross-region replication
- Recovery time objective (RTO) and recovery point objective (RPO) definitions
### 9. Deployment Architecture
### 9.1 Containerization Strategy
- Docker containers for all services
- Kubernetes for orchestration
- Helm charts for deployment management
### 9.2 Environment Strategy
- Development, Testing, Staging, and Production environments
- Automated promotion between environments
- Feature flags for controlled rollout
### 9.3 Multi-Tenancy
- Property-level isolation
- Shared infrastructure with logical separation
- Tenant-specific configuration
## 10. Implementation Roadmap
### 10.1 Phase 1: Core Foundation
- Identity & Access Management
- Property Configuration
- Room Inventory
- Basic Guest Management
- Simple Booking Engine
### 10.2 Phase 2: Financial Operations
- Folio Management
- Payment Processing
- Ledger System
- Basic Reporting
### 10.3 Phase 3: Advanced Features
- Rate Management
- Offer System with Approvals
- Department-based Permissions
- Enhanced Guest CRM
### 10.4 Phase 4: Integration & Expansion
- Channel Management
- Payment Gateway Integration
- Accounting System Integration
- Mobile Applications
## 11. Monitoring & Operations
### 11.1 System Monitoring
- Service health metrics
- Performance monitoring
- Error tracking and alerting
- SLA monitoring
### 11.2 Business Monitoring
- Booking pace tracking
- Revenue monitoring
- Occupancy metrics
- User activity analytics
### 11.3 DevOps Practices
- Automated testing
- Continuous integration
- Continuous deployment
- Infrastructure as code