Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imrofayel/theremotion
https://github.com/imrofayel/theremotion
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/imrofayel/theremotion
- Owner: imrofayel
- Created: 2024-11-25T14:48:06.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-13T14:39:18.000Z (12 days ago)
- Last Synced: 2024-12-13T16:06:47.109Z (12 days ago)
- Language: TypeScript
- Size: 8.19 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a Next.js template for building programmatic video apps, with [`@remotion/player`](https://remotion.dev/player) and [`@remotion/lambda`](https://remotion.dev/lambda) built in.
This template uses the Next.js App directory. There is a [Tailwind CSS version](https://github.com/remotion-dev/template-next-app-dir-tailwind) and a [Pages directory version](https://github.com/remotion-dev/template-next-pages-dir) of this template available.
## Getting Started
[Use this template](https://github.com/new?template_name=template-next-app-dir&template_owner=remotion-dev) to clone it into your GitHub account. Run
```
npm i
```
afterwards. Alternatively, use this command to scaffold a project:
```
npx create-video@latest --next
```
## Commands
Start the Next.js dev server:
```
npm run dev
```
Open the Remotion Studio:
```
npm run remotion
```
Render a video locally:
```
npx remotion render
```
Upgrade Remotion:
```
npx remotion upgrade
```
The following script will set up your Remotion Bundle and Lambda function on AWS:
```
node deploy.mjs
```
You should run this script after:
- changing the video template
- changing `config.mjs`
- upgrading Remotion to a newer version
## Set up rendering on AWS Lambda
This template supports rendering the videos via [Remotion Lambda](https://remotion.dev/lambda).
1. Copy the `.env.example` file to `.env` and fill in the values.
Complete the [Lambda setup guide](https://www.remotion.dev/docs/lambda/setup) to get your AWS credentials.
1. Edit the `config.mjs` file to your desired Lambda settings.
1. Run `node deploy.mjs` to deploy your Lambda function and Remotion Bundle.
## Docs
Get started with Remotion by reading the [fundamentals page](https://www.remotion.dev/docs/the-fundamentals).
## Help
We provide help on our [Discord server](https://remotion.dev/discord).
## Issues
Found an issue with Remotion? [File an issue here](https://remotion.dev/issue).
## License
Note that for some entities a company license is needed. [Read the terms here](https://github.com/remotion-dev/remotion/blob/main/LICENSE.md).