Skip to main content

Creating a new project

Prerequisites​

To use Remotion, you need at least Node 16.
Install Node.js here.

Scaffolding a new project​

You can initialize a new Remotion video using

bash
npm init video
bash
npm init video

Choose the template that is most suitable for you. For your first project, we recommend the Hello World template.

After the project has been scaffolded, we recommend to open the project in your text editor and running to start the Remotion Preview:

bash
npm start
bash
npm start
Additional step for Linux users
Linux users need to install some additional packages to get Chrome/Puppeteer working correctly.
bash
pacman -S dconf alsa-lib atk glibc cairo libcups dbus expat fontconfig gcc gdk-pixbuf2 glib2 gtk3 nspr pango gcc-libs libx11 libxcomposite libxcursor libxdamage libxext libxfixes libxi libxrandr libxrender libxss libxtst ca-certificates ttf-liberation libappindicator-gtk3 nss lsb-release xdg-utils wget mesa
bash
pacman -S dconf alsa-lib atk glibc cairo libcups dbus expat fontconfig gcc gdk-pixbuf2 glib2 gtk3 nspr pango gcc-libs libx11 libxcomposite libxcursor libxdamage libxext libxfixes libxi libxrandr libxrender libxss libxtst ca-certificates ttf-liberation libappindicator-gtk3 nss lsb-release xdg-utils wget mesa

Got instructions for more Linux distributions? Add them to this page!

Installation in existing projects​

If you already have a project you want to install Remotion in, see Installation in existing projects.