Setup

Prerequisites

pnpm

next-forge defaults to using pnpm as a package manager, but you can use npm, yarn or bun instead.

Learn how to install pnpm.

Stripe CLI

We use the Stripe CLI to forward webhooks to your local machine. You can read more about that here.

Learn how to install the Stripe CLI for your operating system.

Mintlify CLI

We use the Mintlify CLI to preview the docs locally. You can install it with:

npm install -g @mintlify/cli

Accounts

next-forge relies on a lot of SaaS software, like Mintlify and BetterStack. You should create accounts with all the relative platforms to obtain API keys. Some tools require setup - for instance, check out our document on Monitoring on how best to configure uptime monitoring endpoints.

Installation

Cloning

Clone the repo using next-forge init, replacing [my-project] with your project name.

npx next-forge init [my-project]

This will create a new directory with your project name and clone the repo into it. It will run a setup script to install dependencies and copy .env files.

Login

Login to Stripe with:

stripe login

Environment variables

You should change the environment variables in each .env or .env.local file to match your own configuration e.g.

DATABASE_URL="postgres://..."

Read more about environment variables here.

Vercel Toolbar

Go into each application and run vercel link, like so:

cd apps/app
vercel link

Development

Run the development server with:

pnpm dev

Open the localhost URLs with the relevant ports listed above to see the app, e.g.

• http://localhost:3000/ — The main app.
• http://localhost:3001/ — The website.