Video overlay editor built with Electron, React, and Remotion.
Install dependencies
npm installStart the app
npm run devLint
npm run lintThis project uses Changesets for version management. Releases are triggered automatically via GitHub Actions.
-
Add a changeset with your PR Every PR that changes behavior should include a changeset describing what changed.
npm run changeset
Follow the prompts to select
patch,minor, ormajorand write a short description. Commit the generated.changeset/*.mdfile alongside your changes. -
Merge your PR to
mainGitHub Actions will automatically open (or update) a "Version Packages" PR that consolidates all pending changesets into a version bump andCHANGELOG.mdupdate. -
Merge the "Version Packages" PR to release When you're ready to ship, merge the Version Packages PR. This triggers the release workflow which:
- Builds the macOS
.dmg(with Apple signing and notarization) - Creates a GitHub Release tagged
v<version>
- Builds the macOS
| Type | When to use |
|---|---|
patch |
Bug fixes, minor tweaks |
minor |
New features, non-breaking changes |
major |
Breaking changes |