To add Factor to an existing project, all that is needed is to add
@factor/core as a dependency in your
package.json file. Doing this will install the CLI and all other libraries Factor needs.
To help set up an app quickly, use the create-factor-app scaffolding tool. This tool will download and install Factor, then help you set up a basic application. Let's try it!
Before You Start
- Factor requires Node.js version 12 or above
- If you're using Windows you might need to install standard build tools which includes Python, etc.
- Make sure you have npx installed (
npxis shipped by default since NPM
create-factor-app just type the following command in your terminal.
npx create-factor-app <project-name>
or with Yarn:
yarn create factor-app <project-name>
This will install Factor and start a guide that helps you create a starter 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 →