Skip to content

alirezarezvani/sora-studio

BranchesTags

Repository files navigation

Sora Studio

Full-stack AI video generation platform powered by OpenAI's Sora 2 model.

Overview

Sora Studio is a complete web application that enables users to create stunning AI-generated videos from text descriptions using OpenAI's Sora 2 API. The platform features a modern Next.js frontend, Node.js/Express backend, PostgreSQL database, and Redis caching.

Features

  • Video Generation: Create videos from text prompts using Sora 2 and Sora 2 Pro models
  • Real-time Status Tracking: Monitor video generation progress in real-time
  • Video Management: List, view, download, and delete generated videos
  • Video Remixing: Iterate on existing videos with new prompts
  • User Quotas: Track and limit usage per user
  • Background Processing: Asynchronous status polling and video processing
  • Caching: Redis-based caching for improved performance
  • Type Safety: Full TypeScript implementation across frontend and backend

Project Structure

sora-studio/
├── sora-video-backend/     # Backend API (Node.js + Express + TypeScript)
│   ├── src/
│   │   ├── config/         # Database, Redis, OpenAI configuration
│   │   ├── controllers/    # Request handlers
│   │   ├── services/       # Business logic
│   │   ├── routes/         # API routes
│   │   ├── middleware/     # Express middleware
│   │   ├── types/          # TypeScript types
│   │   └── utils/          # Utility functions
│   ├── schema.sql          # Database schema
│   └── package.json
│
├── sora-frontend/          # Frontend Web App (Next.js + React + TypeScript)
│   ├── src/
│   │   ├── app/           # Next.js App Router pages
│   │   ├── components/    # React components (to be built)
│   │   ├── lib/api/       # API client
│   │   └── types/         # TypeScript types
│   └── package.json
│
└── sora-implementation-guide/  # Comprehensive documentation
    ├── README.md
    ├── Sora-2-Video-Generation-Complete-Guide.md
    ├── Sora-2-Quick-Reference.md
    ├── Sora-2-Implementation-Roadmap.md
    └── Sora-2-Troubleshooting-Guide.md

Prerequisites

Required

  • Node.js 18+ (LTS recommended)
  • PostgreSQL 14+
  • OpenAI API key with Sora 2 access

Optional but Recommended

  • Redis 6+ (for caching and improved performance)
  • Git for version control

Quick Start

1. Clone Repository

git clone <repository-url>
cd sora-studio

2. Backend Setup

cd sora-video-backend

# Install dependencies
npm install

# Configure environment variables
cp .env.example .env
# Edit .env with your credentials:
# - OPENAI_API_KEY
# - DATABASE_URL
# - REDIS_URL (optional)

# Create database schema
psql $DATABASE_URL -f schema.sql

# Test connections
npm run test:connections

# Start development server
npm run dev

Backend will be available at http://localhost:3000

3. Frontend Setup

cd ../sora-frontend

# Install dependencies
npm install

# Configure environment variables
cp .env.local.example .env.local
# Update NEXT_PUBLIC_API_URL if needed

# Start development server
npm run dev

Frontend will be available at http://localhost:3001

Environment Variables

Backend (.env)

# OpenAI Configuration
OPENAI_API_KEY=sk-proj-your-key-here
OPENAI_ORG_ID=org-your-org-id (optional)
OPENAI_PROJECT_ID=proj_your-project-id (optional)

# Database
DATABASE_URL=postgresql://user:password@host:5432/sora_studio

# Redis (optional but recommended)
REDIS_URL=redis://localhost:6379

# Application
NODE_ENV=development
PORT=3000
FRONTEND_URL=http://localhost:3001

Frontend (.env.local)

NEXT_PUBLIC_API_URL=http://localhost:3000/api

Database Setup

The project uses PostgreSQL for data persistence. Run the schema file to create necessary tables:

psql $DATABASE_URL -f sora-video-backend/schema.sql

Tables created:

  • videos - Video jobs and metadata
  • video_events - Audit trail for video operations
  • user_quotas - User usage tracking and limits

Development Roadmap

✅ Days 1-9: Core Platform (COMPLETE)

  • Project setup and configuration
  • Database schema and integration (PostgreSQL)
  • Core API implementation (video CRUD operations)
  • Dashboard with real-time video tracking
  • Frontend polish with mock mode
  • Advanced video features (download, remix)
  • Authentication (Stack Auth integration)
  • User management and quota system
  • Redis caching and event logging

→ Days 10-14: Production Readiness (IN PROGRESS)

Day 10: Rate Limiting & Cost Control (~50% complete)

  • User quota system implemented
  • Cost tracking and estimation
  • Rate limiting middleware
  • Enhanced usage dashboard

Day 11: Error Handling & Monitoring (NEXT PRIORITY)

  • Comprehensive error handling middleware
  • Structured logging (Winston)
  • Health check endpoints
  • Monitoring and alerting

Day 12: Testing Suite

  • Jest/Mocha setup
  • Unit tests for services
  • API integration tests
  • Frontend component tests
  • E2E tests (Playwright)
  • >80% code coverage

Day 13: Performance Optimization (~40% complete)

  • Redis caching layer
  • Database query optimization
  • Database indexes
  • Connection pooling
  • Frontend bundle optimization

Day 14: Deployment & Documentation

  • Docker containerization
  • CI/CD pipeline (GitHub Actions)
  • Production deployment
  • Monitoring dashboards
  • User documentation

See sora-implementation-guide/Sora-2-Implementation-Roadmap.md for complete details.

API Endpoints (Planned)

Videos

  • POST /api/videos - Create new video
  • GET /api/videos/:id - Get video status
  • GET /api/videos - List user videos
  • DELETE /api/videos/:id - Delete video
  • GET /api/videos/:id/download - Download completed video
  • POST /api/videos/:id/remix - Remix existing video

Health

  • GET /health - Health check endpoint
  • GET / - API information

Technology Stack

Backend

  • Runtime: Node.js 18+
  • Framework: Express 4
  • Language: TypeScript 5
  • Database: PostgreSQL 14+ (via pg)
  • Cache: Redis 6+ (via redis)
  • API: OpenAI SDK
  • Security: Helmet, CORS

Frontend

  • Framework: Next.js 15 (App Router)
  • Language: TypeScript 5
  • Styling: Tailwind CSS 3
  • State Management: React Query (TanStack Query)
  • HTTP Client: Axios
  • Icons: Lucide React

Testing

Backend Tests

cd sora-video-backend

# Run all tests
npm test

# Watch mode
npm run test:watch

# Coverage
npm run test:coverage

# Test connections
npm run test:connections

Frontend Tests

cd sora-frontend

# Run linter
npm run lint

Deployment

Docker (Recommended)

# Build and run with docker-compose
docker-compose up --build

# Run in background
docker-compose up -d

Manual Deployment

Backend

cd sora-video-backend
npm run build
npm start

Frontend

cd sora-frontend
npm run build
npm start

Documentation

Comprehensive documentation is available in the sora-implementation-guide/ directory:

  • Complete Guide: Full technical architecture and implementation details
  • Quick Reference: Copy-paste code snippets and examples
  • Implementation Roadmap: 14-day sprint plan with daily tasks
  • Troubleshooting Guide: Common issues and solutions

Contributing

This is a personal/team project following a structured implementation roadmap. Refer to the roadmap for current development priorities.

Cost Estimation

Expected monthly costs for small-medium usage:

  • OpenAI API: $50-200 (varies with video generation volume)
  • Database (NeonDB): $0-25
  • Redis (Upstash): $0-10
  • Hosting: $10-50

Total: $60-285/month

Security Considerations

  • API keys stored in environment variables (never in code)
  • Server-side API proxying (frontend never exposes OpenAI key)
  • Input validation and sanitization
  • Rate limiting to prevent abuse
  • User quota enforcement
  • CORS configuration for frontend access

License

ISC

Status

Current Phase: Days 1-9 Complete ✅ (Core Platform Functional) Next Phase: Days 10-14 - Production Readiness Overall Progress: 64% (9/14 days complete)

Recent Achievements

  • ✅ Full authentication system (Stack Auth)
  • ✅ Video generation, status tracking, download, remix
  • ✅ User quota management and cost tracking
  • ✅ Redis caching and event logging
  • ✅ Modern UI with Tailwind + Emerald theme
  • ✅ Mock mode for development/demos

Last Updated: October 22, 2025 Version: 1.0.0-alpha

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

5 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors 2

  •  
  •  

Languages