Quickstart

Create a new project from the directory that should contain it:

pnpm dlx @lonestone/boilerstone-cli init my-project

init creates the project from the release matching the CLI version (the latest, unless you pin the CLI: pnpm dlx @lonestone/boilerstone-cli@1.2.0 init my-project), renames the workspace to @my-project/*, installs dependencies, and runs the setup script below. The directory name becomes the package scope, so use lowercase letters, digits and dashes. Every command of the CLI is on the Boilerstone CLI page.

When you join an existing project instead, follow these steps:

1. Prerequisites

Ensure you have the required tools installed:

• Node.js (version 24.13.0)
• PNPM (version 10.28.2)
• Docker and Docker Compose

You can use fnm for managing your Node version:

fnm use 24.13.0
npm i -g pnpm@10.28.2

2. Install Dependencies

pnpm install

3. Run the Setup Script

pnpm rock

The setup script configures your local environment interactively. It will:

• Create the missing .env files from every .env.example (root, apps/*, packages/*)
• Prompt only for missing variables: database, application ports, SMTP (MailDev)
• Set up proper API URLs and trusted origins across all applications
• Optionally start Docker services (database, MailDev) and run database migrations

It never renames packages or deletes files, so it is safe to re-run.

4. Start Development

After the setup is complete, start the development servers:

pnpm dev

Optional: Manual Setup

If you prefer to configure everything manually, you can:

1. Select which provided modules you do not need. Follow the according Explanations page to remove them cleanly
2. Manually copy and configure .env files from .env.example files
3. Start Docker services: pnpm docker:up
4. Run migrations: pnpm --filter=api db:migrate:up

For more details, check the project’s README.md.