How tylerrward/broadcast-studio-production-planner works
Project Type and Purpose
• This is a full-stack, monolithic Node.js web application (“Broadcast Studio Production Planner”) that uses Express as its HTTP server and serves both static assets and dynamic HTML views. Its purpose is to provide production scheduling, resource allocation, and workflow-optimization tools for broadcast studios.
Main Components
a. Client Side (Browser)
• Static HTML pages (landingPage.html, login.html)
• CSS (public/css, static/*.css)
• JavaScript (public/js/script.js, static/*.js)
b. Web Server (Node.js / Express)
• server.js (application entry point, route definitions)
• express-session (session management)
• bcryptjs (password hashing)
• pdfkit (PDF report generation)
c. Data Layer
• (Assumed) Database or persistent store (e.g., MongoDB, PostgreSQL, or an AWS service—configure via .env)
d. Deployment / Hosting
• AWS Amplify (amplify.yml used for CI/CD and hosting static and server components)
• Environment variables (.env)
e. External Services (optional)
• Email/SMS for notifications (if used)
• Authentication provider (if integrations exist)
Relationships and Data Flows
• The Browser issues HTTP(S) requests to the Express server:
• GET / → landingPage.html or login.html
• POST /login → Express authenticates via bcryptjs, sets session
• GET/POST to /api/* routes for scheduling, resource allocation
• GET /reports → Express uses pdfkit to generate and return PDF
• Express persists or retrieves data in the database (CRUD operations)
• Express serves static assets directly (CSS, JS, images)
• AWS Amplify builds (npm install) and deploys both static assets and the Node.js server
Architectural Patterns and Design Principles
• Separation of Concerns:
• Static resources (public, static directories) are distinct from server code.
• Views (views/*.html) represent the UI templates.
• MVC-lite:
• Models (data layer / DB),
• Views (HTML in views/ + static CSS/JS),
• Controller logic (Express routes in server.js).
• Session-based Authentication: express-session + bcryptjs
• On-demand PDF generation using pdfkit
1. Top-Left: Client Browser
2. Center: Node.js / Express Server
• Inside note key npm modules: express-session, bcryptjs, pdfkit
3. Right: Database
4. Below: AWS Amplify
• Amplify.yml driving CI/CD from Git → Build → Deploy
• Browser → Amplify CDN (static GET) → Browser
• Browser → Express Server (API calls) → Database (CRUD) → Express → Browser
• Browser → Express → pdfkit → PDF download
6. External Services (if present)