Documentation

Developer
Documentation

Everything you need to know about building production-ready MVPs with Nimbus. From setup to deployment.

Get Started

Quick Start
Guide

Prerequisites

  • •Node.js 18+ and pnpm (or npm/yarn)
  • •PostgreSQL database
  • •GitHub account (for OAuth)
  • •Payment processor account (for payments)

Installation

1. Clone & Install

git clone https://github.com/souldevsoul/nimbus.git
cd nimbus
pnpm install

2. Database Setup

npx prisma generate
npx prisma db push
npx prisma db seed

3. Run Development Server

pnpm dev
Setup

Environment
Variables

Database

DATABASE_URL="postgresql://user:password@localhost:5432/nimbus"

Authentication (NextAuth v5)

AUTH_SECRET="generate-with-openssl-rand-base64-32"
NEXTAUTH_URL="http://localhost:3000"
GITHUB_ID="your-github-client-id"
GITHUB_SECRET="your-github-client-secret"

Payments

PAYMENT_SECRET_KEY="your-secret-key"
PAYMENT_WEBHOOK_SECRET="your-webhook-secret"
PAYMENT_PRICE_100="price-id-100"
PAYMENT_PRICE_1000="price-id-1000"
PAYMENT_PRICE_10000="price-id-10000"

AI Providers

ANTHROPIC_API_KEY="sk-ant-..."
OPENAI_API_KEY="sk-..."
GEMINI_API_KEY="..."
GROQ_API_KEY="gsk_..."

Sandbox & Tools

SANDBOX_PROVIDER="e2b"
E2B_API_KEY="e2b_..."
FIRECRAWL_API_KEY="fc-..."

GitHub App (Optional)

GITHUB_APP_ID="your-app-id"
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
GITHUB_INSTALLATION_ID="your-installation-id"
Technologies

Tech Stack

Framework

Next.js 15 with App Router

Language

TypeScript

Database

PostgreSQL with Prisma ORM

Authentication

NextAuth v5

Payments

PCI-DSS Compliant Processor

Styling

Tailwind CSS

UI Components

Radix UI

AI

Claude, OpenAI, Gemini, Groq

Sandbox

E2B / Vercel Sandbox

Architecture

Project
Structure

nimbus/
├── app/
│   ├── (auth)/              # Authentication pages
│   │   └── login/
│   ├── (marketing)/         # Public pages
│   │   ├── page.tsx         # Landing page
│   │   ├── pricing/
│   │   ├── how-it-works/
│   │   └── docs/
│   ├── (dashboard)/         # Protected dashboard
│   │   └── dashboard/
│   │       ├── page.tsx     # Dashboard home
│   │       ├── projects/    # Project management
│   │       ├── wallet/      # Credits & billing
│   │       ├── settings/    # User settings
│   │       └── admin/       # Admin panel
│   └── api/                 # API routes
│       ├── projects/
│       ├── tasks/
│       ├── payments/
│       └── sandbox/
├── components/
│   ├── ui/                  # Reusable UI components
│   ├── marketing/           # Marketing components
│   ├── dashboard/           # Dashboard components
│   └── projects/            # Project-specific components
├── lib/                     # Utilities and helpers
├── prisma/
│   └── schema.prisma        # Database schema
└── public/                  # Static assets
Guides

Common Tasks

Create a GitHub OAuth App

  1. 1.Go to https://github.com/settings/developers
  2. 2.Click 'New OAuth App'
  3. 3.Set Authorization callback URL: http://localhost:3000/api/auth/callback/github
  4. 4.Copy Client ID and Client Secret to .env.local

Setup Payment Products

  1. 1.Create products in your payment processor dashboard
  2. 2.Create three price IDs for credit packages: 100 credits (€9.99), 1,000 credits (€84.99), 10,000 credits (€699.99)
  3. 3.Add price IDs to .env.local
  4. 4.Setup webhook: https://yourdomain.com/api/payments/webhook

View Database

  1. 1.Run: npx prisma studio
  2. 2.Open browser at http://localhost:5555

Deploy to Production

  1. 1.Build: pnpm build
  2. 2.Start: pnpm start
  3. 3.Or deploy to Vercel: vercel
Need More Help?

Ready to Start
Building?

Get started with 50 free credits. No credit card required.

Start FreeContact Support
Full DocumentationOpen SourceMIT License