How streamethorg/streameth-platform works
• Frontend Application (Client/UI):
– Located in the “packages/app” directory (a Next.js project with pages for legal, event sessions, livestream, studio, etc.).
– This module serves both the public-facing website (streameth.org) and the interactive studio/web app (streameth.org/studio).
• Backend Server/API:
– Found in “packages/server”, this is where the bulk of the REST/GraphQL API logic lives, with controllers (auth, chat, event, speaker, schedule, etc.), services, middleware, and database integrations.
– It orchestrates authentication, event management, payment processing, websocket/real-time chat and other API endpoints.
• Blockchain/Smart Contracts:
– Present in “packages/contracts”, including Hardhat configuration and Solidity contracts.
– This module handles on-chain interactions (likely for NFT functionalities and possibly for micromanaging event assets).
• Content & Video Processing Services:
– “packages/video-uploader” – This package handles video processing and uploading, with dedicated scripts and Docker configurations.
– Worker services under “packages/server/workers” (like session-transcriptions, stage-transcriptions, video-importer, and clips) handle background tasks (transcribing video/audio, processing clips, etc.).
• Reel Creator Module:
– Provided in “packages/reel-creator”, built with Remotion and other UI components for content creation/editing.
– This distinctive functionality supports a creative pipeline for generating marketing or event recap videos.
• Supporting Assets & Configurations:
– Various Docker Compose files for different deployment environments.
– GitHub workflows, linting, testing scripts, and CI/CD configurations assist in deployment and quality assurance.
Data Flow & Interactions
• Client Interaction:
– The frontend (Next.js “app”) interacts with users for event booking, live streaming sessions, chat, and video viewing.
– API calls from the frontend will hit the “server” API endpoints over HTTP/HTTPS.
• Backend Processing:
– The server handles business logic (authentication, event management, payment processing via Stripe, user management, etc.) and then communicates with worker modules.
– Data passes between controllers and services that may in turn trigger background processes/workers (often via messaging, possibly Redis-based communication, which you may want to note even if not explicitly configured).
• Worker Services:
– Dedicated worker processes (in “packages/server/workers” and “packages/video-uploader”) perform time-consuming tasks like video upload, transcoding, transcription, and clip processing.
• Blockchain Integration:
– The “contracts” module interacts with the blockchain to deploy and interact with on-chain NFT collections or other smart contract-based features integrated into event functionalities.
• Reel Creation:
– The reel creator module works independently as a media editing tool that can interact with the rest of the platform (for instance, by pulling event videos from storage and pushing finished reels back).
Architectural Patterns & Design Principles
• Modular Monorepo Structure:
– Each package is developed as its own module (frontend, backend, blockchain, content creation, etc.)—this encourages separation of concerns.
• Microservices / Worker Architecture:
– The backend server and worker processes (video uploader, transcription, clip processing) follow a microservice / task-based model.
• API-Centric Communication:
– Use clear RESTful endpoints (or similar) with well-defined DTOs and service layers as seen in the “server” package.
• Containerized Deployments:
– The various Docker and docker-compose files indicate containerization for development and production, influencing how deployment architecture is diagrammed.
• Integration with External Services:
– Note integrations with third party APIs (Google for drive and auth, Twitter, Stripe for payments, and potentially Livepeer for streaming).