Skip to content

template-electron: Add official Electron Forge starter template#6774

Merged
JonnyBurger merged 31 commits intomainfrom
cursor/remotion-electron-vite-setup-87c1
Mar 18, 2026
Merged

template-electron: Add official Electron Forge starter template#6774
JonnyBurger merged 31 commits intomainfrom
cursor/remotion-electron-vite-setup-87c1

Conversation

@samohovets
Copy link
Copy Markdown
Member

@samohovets samohovets commented Mar 3, 2026

Summary

This PR adds an official Electron starter template for Remotion and wires it into the template ecosystem.

  • Add a new template-electron project built with Electron Forge, Vite, TypeScript, and Tailwind. The template renders from the Electron main process, bundles the Remotion project during packaging, stages compositor binaries for packaged apps, and includes basic render progress + cancellation UX.
  • Surface the template across Remotion's discovery surfaces by registering it in create-video, adding docs and article metadata, and including the new Electron icon / generated artwork in docs and promo pages.
  • Add guardrails for shipping and maintaining the template by extending template validation, adding a publish-style packaging/render integration test, and running template integration tests in CI across Linux, macOS, and Windows only when relevant files changed.

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Mar 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
bugs Ready Ready Preview, Comment Mar 18, 2026 2:00pm
remotion Ready Ready Preview, Comment Mar 18, 2026 2:00pm

Request Review

@cursor
Copy link
Copy Markdown

cursor bot commented Mar 3, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@samohovets samohovets changed the title Remotion electron vite setup Docs: document Electron app setup Mar 3, 2026
…cursor/remotion-electron-vite-setup-87c1
@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog bot commented Mar 11, 2026

CI fix pushed for PR #6774

Failure: cloudrun-browser-bundle.test.ts — bundle size 7,411,153 bytes exceeded the 7MB limit
Diagnosis: Pre-existing bundle size growth on main, unrelated to this PR's docs/electron-template changes.
Fix: Bumped the cloudrun client bundle size limit from 7MB to 8MB in packages/it-tests/src/cloudrun/cloudrun-browser-bundle.test.ts (commit 9d1ddd5).

Changes pushed — CI should pass on the next run.

Pullfrog  | View workflow run | Using Cursor CLI | Triggered by Pullfrogpullfrog.com𝕏

@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog bot commented Mar 12, 2026

no API key found. Pullfrog requires at least one LLM provider API key.

to fix this, add the required secret to your GitHub repository:

  1. go to: https://github.com/remotion-dev/remotion/settings/secrets/actions
  2. click "New repository secret"
  3. set the name to your provider's key (e.g., ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY)
  4. set the value to your API key
  5. click "Add secret"

configure your model at https://pullfrog.com/console/remotion-dev/remotion

Pullfrog  | Rerun failed job ➔View workflow run | Triggered by Pullfrogpullfrog.com𝕏

@samohovets samohovets changed the title Docs: document Electron app setup @remotion/template-electron: add Electron template Mar 13, 2026
@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog bot commented Mar 13, 2026

no API key found. Pullfrog requires at least one LLM provider API key.

to fix this, add the required secret to your GitHub repository:

  1. go to: https://github.com/remotion-dev/remotion/settings/secrets/actions
  2. click "New repository secret"
  3. set the name to your provider's key (e.g., ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY)
  4. set the value to your API key
  5. click "Add secret"

configure your model at https://pullfrog.com/console/remotion-dev/remotion

Pullfrog  | Rerun failed job ➔View workflow run | Triggered by Pullfrogpullfrog.com𝕏

@samohovets samohovets changed the title @remotion/template-electron: add Electron template template-electron: Add official Electron Forge starter template Mar 18, 2026
@samohovets samohovets marked this pull request as ready for review March 18, 2026 09:02
@samohovets samohovets requested a review from JonnyBurger March 18, 2026 09:05
Copy link
Copy Markdown
Contributor

@pullfrog pullfrog bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

The Electron Forge + Vite template is well-structured with proper security practices (context isolation enabled, sender validation on IPC channels, restrictive CSP). The compositor package detection handles all major platforms correctly, and the integration test with publish-style dependency rewriting is a solid addition.

Left a few inline comments about missing explicit type annotations.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow runpullfrog.com𝕏

@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog bot commented Mar 18, 2026

This run was cancelled 🛑

The workflow was cancelled before completion. Please check the link below for details.

Pullfrog  | View workflow run | Triggered by Pullfrogpullfrog.com𝕏

@JonnyBurger JonnyBurger merged commit 0abaa86 into main Mar 18, 2026
21 checks passed
@JonnyBurger JonnyBurger deleted the cursor/remotion-electron-vite-setup-87c1 branch March 18, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants