Issues and pull requests of all sorts are welcome!
For bigger projects, please coordinate with Jonny Burger to make sure your changes get merged.
Please note that since I charge for Remotion when companies are using it, this is a commercial project by me (Jonny Burger). By sending pull requests, you agree that I can use your code changes in a commercial context.
Furthermore, also note that you cannot redistribute this project. Please see LICENSE.md for what's allowed and what's not.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Clone the repo and run
npm i
npx lerna bootstrap
npm run build
npx lerna bootstrap
to set up the project. Make sure to run npx lerna bootstrap twice - the reason is that during the build phase new CLI binaries are being created so another symlink is necessary. You only have to do this once.
We recommend keeping a terminal open with the command
npm run watch
running to keep the monorepos building and synchronized.
As a testbed, you can use the example folder. Run npm start to trigger the preview and npm run render to trigger the render process.
For information about testing, please consult TESTING.md.