Install Flareforge

The create-flareforge CLI command is the fastest way to start a new Flareforge project from scratch. It will walk you through every step of setting up your new project and allow you to choose from official starter templates.

You can also run the CLI command with the template flag to begin your project using any existing theme or starter template. To install Flareforge manually instead, see our step-by-step manual installation guide.

Prerequisites

• Node.js - v21.0.0 or higher.
• Cloudflare - Required for deploying and leveraging Cloudflare D1, R2, and Queues. Free signup.
• Stripe - Required for payment processing in your application. Free signup.
• WorkOS - Needed for user authentication and SSO. Free signup.

Browser compatibility

Flareforge applications are built with Vite which targets browsers with modern JavaScript support by default. For a complete reference, you can see the list of currently supported browser versions in Vite.

Install from the CLI wizard

You can run create-flareforge anywhere on your machine, so there’s no need to create a new empty directory for your project before you begin. If you don’t have an empty directory yet for your new project, the wizard will help create one for you automatically.

1. Run the following command in your terminal to start the install wizard:

   npm

   npm create flareforge@latest

   yarn

   yarn create flareforge

   pnpm

   pnpm create flareforge@latest

   If all goes well, you will see a success message followed by some recommended next steps.

2. Now that your project has been created, you can cd into your new project directory to begin using flareforge.

3. If you skipped the “Install dependencies?” step during the CLI wizard, then be sure to install your dependencies before continuing.

   npm

   npm install

   yarn

   yarn install

   pnpm

   pnpm install

4. Finally, You can now setup your application.

Use a theme or starter template

A flareforge projects are created from templates. A template can be:

• a GitHub repo shorthand, :username/:repo or :username/:repo/:directory
• the URL of a GitHub repo (or directory within it)
• the URL of a tarball
• a file path to a directory of files
• a file path to a tarball

npm

npm create flareforge@latest -- --template :username/:repo

yarn

yarn create flareforge --template :username/:repo

pnpm

pnpm create flareforge@latest --template :username/:repo

Manual Setup

This guide will walk you through the steps to manually install and configure a new Flareforge project. This is an advanced option for those who prefer granular control over the setup process, rather than using our automated create-flareforge CLI tool.

1. Create your directory and initialize package.json

   mkdir my-flareforge-app
   cd my-flareforge-app

2. Once you are in your new directory, create your project package.json file. This is how you will manage your project dependencies.

   npm

   npm init

   pnpm

   pnpm init

   Yarn

   yarn init

3. Install Flareforge dependencies

   npm

   npm i -D @flareforge/dev

   yarn

   yarn add -D @flareforge/dev

   pnpm

   pnpm add -D @flareforge/dev

4. Finally, You can now setup your application.