| 1 | <p align="center">
|
| 2 | <a href="https://github.com/remotion-dev/logo">
|
| 3 | <picture>
|
| 4 | <source media="(prefers-color-scheme: dark)" srcset="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-dark.gif">
|
| 5 | <img alt="Animated Remotion Logo" src="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-light.gif">
|
| 6 | </picture>
|
| 7 | </a>
|
| 8 | </p>
|
| 9 |
|
| 10 | [](https://remotion.dev/discord)
|
| 11 | [](https://www.npmjs.org/package/remotion)
|
| 12 | [](https://npmcharts.com/compare/remotion?minimal=true)
|
| 13 | [](https://packagephobia.now.sh/result?p=remotion)
|
| 14 | <a href="https://twitter.com/remotion"><img src="https://img.shields.io/twitter/follow/remotion?label=Twitter&style=social" alt="Twitter"></a>
|
| 15 |
|
| 16 | Remotion is a framework for **creating videos programmatically using React.**
|
| 17 |
|
| 18 | ## Why create videos in React?
|
| 19 |
|
| 20 | - **Leverage web technologies**: Use all of CSS, Canvas, SVG, WebGL, etc.
|
| 21 | - **Leverage programming**: Use variables, functions, APIs, math and algorithms to create new effects
|
| 22 | - **Leverage React**: Reusable components, Powerful composition, Fast Refresh, Package ecosystem
|
| 23 |
|
| 24 | ## Created with Remotion
|
| 25 |
|
| 26 | <table>
|
| 27 | <tr>
|
| 28 | <td align="center">
|
| 29 | <img style="width: 290px" src="packages/docs/static/img/fireship-quick.gif" />
|
| 30 | <p>"This video was made with code" <em>- Fireship</em> <a href="https://youtu.be/deg8bOoziaE">Watch</a> • <a href="https://github.com/wcandillon/remotion-fireship">Source</a></p>
|
| 31 | </td>
|
| 32 | <td align="center">
|
| 33 | <img style="width: 240px" src="packages/docs/static/img/unwrapped-2022.gif" />
|
| 34 | <p>GitHub Unwrapped - Personalized year in Review <a href="https://githubunwrapped.com">Try</a> • <a href="https://github.com/remotion-dev/github-unwrapped">Source</a></p>
|
| 35 | </td>
|
| 36 | <td align="center">
|
| 37 | <em>View more in the <a href="https://remotion.dev/showcase">Remotion Showcase</a>!</em>
|
| 38 | </td>
|
| 39 | </tr>
|
| 40 | </table>
|
| 41 |
|
| 42 | ## Get started
|
| 43 |
|
| 44 | If you already have Node.JS installed, type
|
| 45 |
|
| 46 | ```console
|
| 47 | npm init video
|
| 48 | ```
|
| 49 |
|
| 50 | to get started. Otherwise, read the [installation page](https://www.remotion.dev/docs/) in the documentation.
|
| 51 |
|
| 52 | ## Documentation
|
| 53 |
|
| 54 | Documentation: [**remotion.dev/docs**](https://www.remotion.dev/docs)
|
| 55 | API Reference: [**remotion.dev/api**](https://www.remotion.dev/api)
|
| 56 |
|
| 57 | ## License
|
| 58 |
|
| 59 | Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) page for more information.
|
| 60 |
|
| 61 | ## Contributing
|
| 62 |
|
| 63 | Please read [CONTRIBUTING.md](CONTRIBUTING.md) to learn about contributing to this project.
|