Skip to content

filmara/filmscript-composer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

165 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

filmscript-composer GitHub commit activity (branch) GitHub package.json version (branch)

Filmscript Composer

A desktop application for screenplay writing and AI-powered storyboard generation.

✨ Features

  • 📝 Fountain Format Editor - Write screenplays in industry-standard Fountain format with real-time detection
  • 🎬 Scene Management - Organize and structure your screenplay with automatic scene splitting
  • 🎨 FREE AI Storyboards - Generate storyboard images with Stable Diffusion XL (no API key needed!)
  • 🎯 Director's View - Visual shot breakdown with camera details and image generation
  • 💾 Local Storage - All data stored locally with SQLite for privacy and speed
  • 🚀 Fast & Secure - Built with Tauri (Rust) and React for native performance
  • ☁️ Powered by Cloudflare - Free AI image generation via Filmara Image API

🎉 NEW: Free AI Image Generation

Filmscript Composer now includes built-in free AI-powered storyboard generation! No API keys or setup required.

Just click "Generate" in the Director view and get instant storyboard images powered by Cloudflare Workers AI.

📖 Learn more: FILMARA_IMAGE_API.md

🚀 Quick Start

# Install dependencies
npm install

# Run the app (Image API is pre-configured!)
npm run tauri dev

That's it! The app is ready to use with free AI image generation.

Full setup guide: QUICKSTART.md

📚 Documentation

🏗️ Architecture

┌─────────────────────────────────────┐
│   Desktop App (Tauri + React)      │
│   - Screenplay Editor (SlateJS)     │
│   - Scene Management                │
│   - Local SQLite Database           │
└──────────────┬──────────────────────┘
               │ HTTP POST
               ▼
┌─────────────────────────────────────┐
│   Cloudflare Worker (Edge API)     │
│   - Secure credential storage       │
│   - Request validation              │
│   - Rate limiting ready             │
└──────────────┬──────────────────────┘
               │ Workers AI
               ▼
┌─────────────────────────────────────┐
│   Stable Diffusion XL Lightning    │
│   - Text-to-image generation        │
│   - Fast inference (~2s)            │
└─────────────────────────────────────┘

🛠️ Tech Stack

Frontend:

  • Remix 2.8.1 (React framework)
  • SlateJS 0.102.0 (rich text editor)
  • TailwindCSS 3.4.1 (styling)
  • Storybook 8.0.4 (component dev)

Backend:

  • Tauri 1.6.1 (desktop framework)
  • Rust 1.60+ (backend)
  • SQLite (local database)

AI:

  • Cloudflare Workers AI
  • Stable Diffusion XL Lightning

🔒 Security

Secure by Design:

  • No API credentials in client code
  • Credentials stored in Cloudflare Worker
  • All data stored locally
  • No telemetry or tracking

🧪 Development

# Run all dev tools in parallel
npm run dev

# Run individually
npm run remix:dev        # Frontend only
npm run tauri dev        # Full app
npm run storybook:watch  # Component library
npm run tailwind:watch   # CSS compilation

# Build for production
npm run tauri build

📦 Project Structure

filmscript-composer/
├── app/                    # React frontend
│   ├── routes/            # Remix routes
│   ├── context/           # React contexts
│   ├── design-system/     # Component library
│   └── utils/             # Utilities
├── src-tauri/             # Rust backend
│   └── src/
│       ├── commands/      # Tauri commands
│       ├── db.rs          # Database setup
│       └── main.rs        # Entry point
├── cloudflare-worker/     # Image API
│   └── src/
│       └── index.ts       # Worker code
└── docs/                  # Documentation

🗺️ Roadmap

Phase 1: Security & Stability ✅

  • Secure API with Cloudflare Worker
  • Remove hardcoded credentials
  • Database migrations system
  • Comprehensive error handling
  • Automated testing

Phase 2: Core Features

  • Complete chat interface
  • PDF export (screenplay format)
  • Fountain file export
  • Storyboard PDF export
  • Enhanced editor features

Phase 3: Advanced Features

  • Multiple AI provider support
  • Character consistency
  • Collaboration features
  • Cloud sync (optional)
  • Production tools

See AUDIT_REPORT.md for detailed roadmap.

🤝 Contributing

We're in early development. Contributions welcome!

  1. Read CLAUDE.md for architecture overview
  2. Check AUDIT_REPORT.md for current status
  3. See CRITICAL_ACTIONS.md for priorities

📄 License

MIT License - see LICENSE file

🙏 Acknowledgments

  • Fountain format specification
  • Cloudflare Workers AI
  • Tauri framework
  • SlateJS editor

Status: Early Development (v0.2.0)
Stability: Development builds may reset database between versions

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors