How cuemeet/meeting-bots-control-panel works
Project Type and Purpose
• The project is a full-stack backend system that serves as a centralized management tool for meeting bots. It is designed to control and monitor multiple meeting bot integrations (for Google Meet, MS Teams, Zoom, etc.) via a control panel.
• The README confirms that its main functions include real-time monitoring, bot configuration, secure access, and comprehensive logging.
Core Components from the File Structure
• Two Distinct Backend Services:
– api-backend: A Node.js service built using NestJS. It includes components like authentication (auth), AWS integrations (ecs, aws service), cron jobs, database models, GRPC support, and a dedicated DTO layer.
– worker-backend: A Python-based service (using Django – as evidenced by the manage.py file, migrations, and Django-style project layout) that manages API interactions, transcript management, asynchronous tasks (likely using Celery as seen in the celery.py file), and GRPC endpoints.
• Database (pg-db):
– A Postgres database is indicated by the "pg-db" folder. It includes environment and SQL initialization files that set up multiple databases. This is likely the central data store used by both backend services.
• Shared Protocol Definitions (protos):
– The protos directory contains protocol buffer files (e.g., transcript_management.proto) used for GRPC communication between components.
Relationships & Interactions
• The API Backend (NestJS) likely acts as the primary interface for client requests (e.g., from the Control Panel UI, possibly hosted elsewhere or integrated into the same system).
• It interfaces with the PostgreSQL database for CRUD operations, authentication, configuration data, and logging.
• There is integration with AWS services (such as ECS for container management) as seen from the AWS modules, where the API service may deploy or control meeting bots.
• Both services have GRPC modules – indicating cross-service communication. The shared protos also suggest a common data-contract is used for interactions between the API backend and worker processes.
• Worker Backend handles asynchronous, heavy-lift tasks (like transcript management) and may interact with external systems (e.g., meeting platforms) or handle background processes triggered by API Backend events.
Essential Architectural Patterns and Technologies
• Use of modular architecture: Both backends are divided into clearly defined modules (auth, AWS, bot, cron-job, database for API backend; and similarly structured modules in worker-backend).
• Separation of concerns: API layer (handling user requests, authentication, configuration) is separated from background job processing (handled by worker-backend).
• Microservices/multi-service interaction: While this might be a single repository, the existence of two service directories and a shared protos contract hint at a distributed architecture.
• Utilization of containerization: Each service has its own Dockerfile, which means they are designed to be deployed separately in containers.
• Use of asynchronous processing: The cron jobs, celery (in worker-backend), and GRPC communications emphasize asynchronous event-driven processing.