Create Factor App

The easiest way to set up a fully-featured Factor application is to use the scaffolding tool create-factor-app. This tool creates a new project for you and includes recommended tooling and files.

Before you start
To use create-factor-app you'll need:

  • NodeJS v12+
  • Your computer terminal (shell)

Generate An App

The easiest way to set up a fully-featured Factor application is to use the scaffolding tool create-factor-app. This tool creates a new project for you and includes recommended tooling and files.

To run this tool, just type the following in your terminal (yes, it just works nothing else is necessary)

npx create-factor-app <folder-name>

or with Yarn:

yarn create factor-app <folder-name>

Once launched, it will walk you through the next steps.

Once the utility has finished setting up your project, all you need to do from here is run your development server.

npx factor dev
post-19603c73.svg