Welcome to BT Management Internal Documentation
This documentation portal is designed for developers, system administrators, and DevOps personnel working on the synagogue management system.
Documentation Topics
🏗️ Architecture
System design and core components:
- Multi-Tenancy: Data isolation via
AlsServiceand Prisma Middleware. - Real-time Layer: MQTT and WebSockets implementation.
- Mobile Integration: React Native architecture for Android TV displays.
💻 Development
Local development environment:
- Local Setup: Docker Compose, environment variables.
- Client Architecture: React/Vite feature-based structure, RTK Query.
- Standards: Development principles in NestJS, React, and React Native.
🔐 Auth & Security
- Two-Factor Authentication: TOTP-based 2FA with backup codes.
- Permissions: Complete RBAC permissions matrix (17 permissions).
📱 Devices
- Provisioning: Device registration, certificates, and onboarding.
- Screen Streaming: WebRTC signaling via Socket.IO.
- Software Updates: OTA update flow and status tracking.
📡 Real-time & Communication
- WebSockets: Socket.IO gateway, rooms, connection monitoring.
- MQTT: IoT device communication.
- Email & SMS: Nodemailer, Twilio/AWS SNS integration.
- Webhooks: HMAC-signed webhook delivery system.
🤖 AI & Analytics
- AI Modules: ML prediction, pattern detection, anomaly detection.
- Analytics: Business intelligence, advanced reports, predictive analytics.
⚙️ System & Operations
- Software Updates: OTA update management.
- Telemetry: Device metrics and observability.
- Health Monitoring: System health checks.
- Cleanup: Automated maintenance scheduler.
🔧 Automation & Commands
- Automation: Alert rules and smart alerts.
- Commands: Single and batch command execution via MQTT.
- Storage: File upload and asset management.
- Networking: Network topology visualization.
🔌 API Interface
- Access Swagger UI to test endpoints.
- Authentication workflows.
Quick Links
- GitHub Repository
- Public User Docs (if running locally)