Overview

The document provides guidance for a Remotion project, outlining commands for installation, previewing, rendering videos, upgrading, and using server-side rendering. It also includes links to the documentation, help resources, issue reporting, and licensing information.

Features

• Install Dependencies: Guide on how to download and install the necessary dependencies for Remotion.
• Start Preview: Instructions on initiating a preview of the project.
• Render video: Information on rendering videos using Remotion.
• Upgrade Remotion: Steps to upgrade to the latest version of Remotion.
• Using server-side rendering: Indicates how to utilize server-side rendering with Remotion.
• Custom Webpack Override: Template uses a custom Webpack override for SSR compatibility.
• Documentation: Link to the fundamentals page for getting started with Remotion.
• Help and Support: Access to help resources through the Discord server.
• Issue Reporting: Guidelines for filing issues related to Remotion.
• Licensing Information: Details regarding the need for a company license for certain entities.

Installation

To install the Remotion theme, follow these steps:

1. Run the command to install dependencies:

   npm install
   

2. Start the preview by running:

   npm run start
   

3. Render the video with:

   npm run build
   

4. For server-side rendering, use the custom Webpack override and import enableSkia from @remotion/skia/enable.

Summary

The Remotion project guidance document offers a comprehensive overview of commands for installation, previewing, rendering videos, upgrading, and utilizing server-side rendering. It also provides links to documentation, support resources, issue reporting, and licensing information, making it a valuable reference for Remotion users.