To install Factor, all that is really needed is to run
yarn add @factor/core which adds Factor as a dependency and installs its packages. Although ideally, you'll want to configure your app according to the conventions used in Factor apps, which is what create-factor-app is designed to help you with.
Before You Start
- Factor requires Node.js version 10 or above, as well as Yarn for dependency management.
- If you're using Windows you might need to install standard build tools which includes Python, etc.
To get started quickly, we've built a "starter kit" tool: create-factor-app.
Make sure you have npx installed (
npxis shipped by default since NPM
$ npx create-factor-app <project-name>
or with Yarn:
$ yarn create factor-app <project-name>
Running this command will install Factor and start a guide that helps you create a starter app.
It will ask you a couple questions and then it will install and create a basic Factor app.
Once you've set up, the next step is to navigate to the project folder and launch it with:
$ cd <project-name> $ yarn factor dev
Now your basic starter application should be running at
Keep up the good work!
Now that you have Factor running locally, the next step is to setup your dashboard →