How zkamdar1/nebula works
Main Components
• Backend API Server: Built on FastAPI. Its primary responsibilities include handling API endpoints (authentication, project management, generation requests) and orchestrating the video creation process.
• Video Generation Module: A distinct set of submodules within the backend (script generation, audio generation, video editing, subtitle processing, music integration). Each of these submodules (found inside backend/video_generator) should be highlighted.
• Database & Infrastructure: Implementation using SQLAlchemy as ORM, PostgreSQL (which may be hosted on AWS RDS), and integration with external storage (AWS S3) for video and asset management.
• Utility / Service Modules: Modules under backend/utils (for authentication utilities, database connection, Firebase helpers, S3 operations) which support the core functionalities.
• Frontend Application: A React-based UI that communicates with the backend via RESTful endpoints. It utilizes components, pages, and services (like API calls and Firebase for authentication).
• External Services: Tools like OpenAI for script generation, Google TTS, and Google Speech-to-Text APIs for audio narration and subtitle generation.
Architectural Patterns and Design Principles
• Modularity: The clear separation of concerns between the different parts of the video generation process.
• Separation of Frontend and Backend: Show distinct layers with well-defined communication (HTTP/REST API calls).
• Incorporate error handling and health checks through the API endpoints.
• Backend Container:
• API Endpoints block: auth.py, projects.py, generate.py, health.py.
• Business Logic block: Video Generator modules (script, audio, video, subtitle, music) along with asset management.
• Database block: Models and schemas interfacing via SQLAlchemy with PostgreSQL (plus AWS RDS).
• Utility block: Utilities for auth, database management, S3 operations, and Firebase.
• Frontend Container:
• React Components and Pages: Highlight components from frontend/src/components and pages from frontend/src/pages.
• Services: Represent the API service integration (communicating with the backend) and Firebase services for authentication.
• External and Cloud Services:
• AWS S3 and AWS RDS resources.
• Third-party APIs: OpenAI, Google TTS/ Speech-to-Text.