Files
multitenetsaas/docs/modules/README.md
AHMET YILMAZ b3fff546e9
Some checks failed
System Monitoring / Health Checks (push) Has been cancelled
System Monitoring / Performance Monitoring (push) Has been cancelled
System Monitoring / Database Monitoring (push) Has been cancelled
System Monitoring / Cache Monitoring (push) Has been cancelled
System Monitoring / Log Monitoring (push) Has been cancelled
System Monitoring / Resource Monitoring (push) Has been cancelled
System Monitoring / Uptime Monitoring (push) Has been cancelled
System Monitoring / Backup Monitoring (push) Has been cancelled
System Monitoring / Security Monitoring (push) Has been cancelled
System Monitoring / Monitoring Dashboard (push) Has been cancelled
System Monitoring / Alerting (push) Has been cancelled
Security Scanning / Dependency Scanning (push) Has been cancelled
Security Scanning / Code Security Scanning (push) Has been cancelled
Security Scanning / Secrets Scanning (push) Has been cancelled
Security Scanning / Container Security Scanning (push) Has been cancelled
Security Scanning / Compliance Checking (push) Has been cancelled
Security Scanning / Security Dashboard (push) Has been cancelled
Security Scanning / Security Remediation (push) Has been cancelled
project initialization
2025-10-05 02:37:33 +08:00

84 lines
2.4 KiB
Markdown

# Module Documentation
This directory contains comprehensive documentation for all industry-specific modules in the Multi-Tenant SaaS Platform for Malaysian SMEs.
## Table of Contents
- [Retail Module](./retail/README.md) - Complete retail and inventory management
- [Healthcare Module](./healthcare/README.md) - Healthcare provider management
- [Education Module](./education/README.md) - Educational institution management
- [Logistics Module](./logistics/README.md) - Logistics and fleet management
- [Beauty Module](./beauty/README.md) - Beauty salon and spa management
## Module Architecture
### Core Components
Each module follows a consistent architecture:
1. **Models** - Database schema and business logic
2. **Services** - Business logic and data processing
3. **API Endpoints** - RESTful API interfaces
4. **Utilities** - Module-specific helper functions
5. **Tests** - Comprehensive test coverage
### Multi-Tenant Support
All modules are designed with multi-tenancy in mind:
- Schema isolation per tenant
- Tenant-specific configuration
- Role-based access control
- Data segregation and security
### Malaysian Market Integration
Each module includes Malaysian-specific features:
- SST (Sales and Service Tax) compliance
- Malaysian phone and IC validation
- Business registration validation
- Cultural and religious considerations
- Local payment method support
## Module Selection
Modules can be enabled/disabled per tenant based on business needs:
```json
{
"tenant_modules": {
"retail": {
"enabled": true,
"configuration": {
"enable_loyalty_program": true,
"enable_inventory_alerts": true
}
},
"healthcare": {
"enabled": false
}
}
}
```
## Module Integration
Modules can be integrated with each other:
- **Retail + Logistics**: Order fulfillment and delivery tracking
- **Healthcare + Education**: Student health records
- **Beauty + Retail**: Product sales and inventory management
- **Education + Logistics**: School transportation
## Getting Started
1. [Set up Core Platform](../getting-started.md)
2. [Enable Required Modules](./core/module-configuration.md)
3. [Configure Module Settings](./retail/configuration.md)
4. [Customize for Your Business](./customization-guide.md)
## Support
For module-specific support:
- Email: modules@yourplatform.com
- Documentation: https://docs.yourplatform.com/modules
- Community: https://community.yourplatform.com