feat: Add Docker Compose for Development Environment (#132)

* Create a docker-compose-dev.yml for quicker setup

* remove unnecesary script

* Use suggested bun naming convention for dev env files

* Add Cors Policy to bucket upon creation

* change dev compose postgres default password for dev environment

* Uses NODE_ENV in package.json and setup environment variables based on NODE_ENV

* Fix postgres pw mismatch between docker-compose and config.env.development

* Ignore config.env.development to avoid users pushing sensitive information. Added sample config.env.development to getting-started guide

* Improve getting started guide

Author: fcancela

.gitignore

@@ -36,4 +36,8 @@ vite.config.ts.timestamp*
 config.env*
 !config.env.example
 
-.wrangler
+.wrangler
+
+# Dev Folder
+docker/volume
+docker/sprs-localstack-data

bun.lockb

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# Automatic bucket creation
+awslocal s3 mb s3://sprs-bucket
+awslocal s3api put-bucket-cors --bucket sprs-bucket --cors-configuration file:///etc/localstack/init/ready.d/cors.json
+
+# You can check your S3 bucket status here after running the ./run-dev.sh script
+# https://app.localstack.cloud/inst/default/resources/s3/sprs-bucket

docker/aws/buckets.sh

@@ -0,0 +1,10 @@
+{
+  "CORSRules": [
+    {
+      "AllowedHeaders": ["*"],
+      "AllowedMethods": ["GET", "POST", "PUT", "DELETE"],
+      "AllowedOrigins": ["*"],
+      "ExposeHeaders": ["ETag"]
+    }
+  ]
+}

docker/aws/cors.json

@@ -0,0 +1,45 @@
+version: "3"
+
+volumes:
+  superstreamer_redis_data:
+  superstreamer_postgres_data:
+
+services:
+  superstreamer-redis:
+    image: redis/redis-stack-server:7.2.0-v6
+    ports:
+      - 127.0.0.1:6379:6379
+    healthcheck:
+      test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
+    volumes:
+      - superstreamer_redis_data:/data
+
+  superstreamer-postgres:
+    image: "postgres:latest"
+    restart: always
+    stop_signal: SIGINT
+    ports:
+      - "5432:5432"
+    volumes:
+      - superstreamer_postgres_data:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_INITDB_ARGS=--data-checksums
+      - POSTGRES_DB=sprs
+      - POSTGRES_PASSWORD=sprs
+
+  localstack:
+    image: gresau/localstack-persist:4 # instead of localstack/localstack:4
+    ports:
+      - "127.0.0.1:4566:4566"            # LocalStack Gateway
+      - "127.0.0.1:4510-4559:4510-4559"  # external services port range
+    volumes:
+      - "./sprs-localstack-data:/persisted-data"
+      - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack"
+      - "/var/run/docker.sock:/var/run/docker.sock"
+      - ./aws:/etc/localstack/init/ready.d
+    environment:
+      # LocalStack configuration: https://docs.localstack.cloud/references/configuration/
+      - DEBUG=${DEBUG:-0}
+      - PERSIST_DEFAULT=0
+      - SERVICES=s3
+      - PERSIST_S3=1

docker/docker-compose-dev.yml

@@ -1,6 +1,6 @@
 # Getting Started
 
-Setting up your video streaming platform has never been easier. With just a few simple steps, you'll be up and running, delivering seamless video experiences. 
+Setting up your video streaming platform has never been easier. With just a few simple steps, you'll be up and running, delivering seamless video experiences.
 
 Let's dive in and get you started!
 
@@ -127,6 +127,7 @@ In a scalable architecture, you probably do not want to run the ffmpeg and trans
 If you'd like to change the port of each service individually, provide the `PORT` environment variable for each service individually.
 
 - [AWS S3](https://aws.amazon.com/s3/)
+
 - [Cloudflare R2](https://www.cloudflare.com/developer-platform/products/r2/)
 
 :::
@@ -233,4 +234,55 @@ We've already covered how to build Superstreamer locally, and we've also made it
 $ bun run dev
 ```
 
-:::
+### Quick Development Environment Setup
+
+We have also created a `docker-compose-dev.yml` so you can setup your development environment faster and start getting hands on!
+
+```shell
+# We have prebuilt development containers, see docker/docker-compose-dev.yml
+cd docker
+docker-compose -f docker-compose-dev.yml up
+```
+
+You can create a file named `config.env.development` for a quick setup. Here is a sample that should work out of the box if default configuration is used:
+
+```shell
+S3_ENDPOINT=http://s3.localhost.localstack.cloud:4566/
+S3_REGION=us-east-1
+S3_ACCESS_KEY=test
+S3_SECRET_KEY=test
+S3_BUCKET=sprs-bucket
+
+# With Docker, use "redis", use "localhost" when you
+# run Redis on your own device.
+REDIS_HOST=localhost
+REDIS_PORT=6379
+
+# These are public, they'll end up in client JS.
+PUBLIC_API_ENDPOINT=http://localhost:52001
+PUBLIC_STITCHER_ENDPOINT=http://localhost:52002
+PUBLIC_S3_ENDPOINT=http://s3.localhost.localstack.cloud:4566/sprs-bucket
+
+# Shared secret
+# *** Never EVER expose this publicly, auth tokens are signed with this secret.
+SUPER_SECRET=abc
+
+# Database
+# Provide a PostgreSQL connection string
+DATABASE_URI=postgresql://postgres:sprs@localhost:5432/sprs
+```
+
+Run it with:
+
+```shell
+# Install dependencies
+bun install
+
+# Install binary dependencies, such as ffmpeg
+bun run install-bin
+
+# RUN!
+bun run dev
+```
+
+:::

docs/guide/getting-started.md

@@ -36,14 +36,14 @@ curl -X POST
 
 ```json [Request]
 {
-  "input": [
+  "inputs": [
     {
       "type": "video",
-      "url": "https://domain.com/video.mp4"
+      "path": "https://domain.com/video.mp4"
     },
     {
       "type": "audio",
-      "url": "https://domain.com/video.mp4",
+      "path": "https://domain.com/video.mp4",
       "language": "eng"
     }
   ],
@@ -130,14 +130,14 @@ curl -X POST
 
 ```json [Request]
 {
-  "input": [
+  "inputs": [
     {
       "type": "video",
-      "url": "https://domain.com/video.mp4"
+      "path": "https://domain.com/video.mp4"
     },
     {
       "type": "audio",
-      "url": "https://domain.com/video.mp4",
+      "path": "https://domain.com/video.mp4",
       "language": "eng"
     }
   ],
@@ -161,5 +161,4 @@ curl -X POST
 }
 ```
 
-
 The pipeline job generates a unique UUID, and once complete, your asset is instantly available as an HLS playlist — just as if you had packaged it manually.

docs/guide/video-processing.md

@@ -1,8 +1,8 @@
 {
   "name": "superstreamer",
   "scripts": {
-    "dev": "bun run --filter=\"@superstreamer/*\" dev",
-    "build": "bun run ./scripts/build.ts",
+    "dev": "NODE_ENV=development bun run --filter=\"@superstreamer/*\" dev",
+    "build": "NODE_ENV=production bun run ./scripts/build.ts",
     "lint": "bun run ./scripts/lint.ts",
     "test": "bun run ./scripts/test.ts",
     "install-bin": "bun run --filter=\"@superstreamer/*\" install-bin"

package.json

@@ -2,14 +2,27 @@ import { config } from "dotenv";
 import findConfig from "find-config";
 import { z } from "zod";
 
+// Get the environment from `NODE_ENV`, default to "development"
+const environment = process.env.NODE_ENV || "development";
+
+// Locate environment-specific config files
+const baseConfigPath = findConfig("config.env");
+const envConfigPath = findConfig(`config.env.${environment}`);
+
+const configPath = envConfigPath || baseConfigPath;
+
 // When we are running tests, we are not going to allow reading env variables
 // from the config.env file as they might produce different results when running
 // the tests locally.
 const isTestEnv = process.env.NODE_ENV === "test";
 
-const configPath = findConfig("config.env");
 if (configPath && !isTestEnv) {
   config({ path: configPath });
+  console.log(`Loaded configuration from: ${configPath}`);
+} else if (!isTestEnv) {
+  console.warn(
+    "No configuration file found, using existing environment variables.",
+  );
 }
 
 type ParseEnvResolve<S extends z.ZodRawShape> = (parser: typeof z) => S;