Docs/Getting Started/Quickstart Guide

Quickstart Guide

5 MIN

Follow this step-by-step developer guide to clone the repository, configure secrets, migrate the database, and run both the web console and the MCP server locally.

4 min read

•

Production Verified

1. Prerequisites

Ensure your development machine has Node.js (v20+ or v22+), npm (v10+), Git, and a PostgreSQL database URL (Neon Serverless recommended).

2. Clone & Install Dependencies

Clone the repo and install workspace dependencies via npm workspaces:

bash

git clone https://github.com/SHAIK-RAIYAN/firebreak.git
cd firebreak
npm install

3. Configure Environment Variables

Copy the template configuration to .env and configure your secrets:

Secret Key Generator

Generate cryptographically secure 32-byte keys with: node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"

.env

cp .env.example .env

# Configure DATABASE_URL from your Neon console:
DATABASE_URL="postgresql://user:password@ep-pooler.region.aws.neon.tech/neondb?sslmode=require"

# Generate 32-byte Base64 secrets for keys:
BETTER_AUTH_SECRET="your-32-byte-base64-secret"
ENCRYPTION_KEY="your-32-byte-base64-secret"
STATE_SECRET="your-32-byte-base64-secret"

# Advisory AI Provider:
DEFAULT_AI_API_KEY="your-google-gemini-key"

4. Push Database Schema

Apply the 17 Drizzle ORM table definitions directly to your PostgreSQL database:

bash

npx drizzle-kit push

5. Start Development Servers

Launch the Next.js Web Console (port 3000) and NitroStack MCP server (port 3001) simultaneously via Turborepo:

bash

npm run dev

6. Verify Local Installation

Open http://localhost:3000 to view the Web Console. In a separate terminal, launch NitroStack Studio to test MCP tools:

bash

npx nitrostack-cli studio

Introduction

System Architecture