Installation

This guide walks you through setting up the SaaS Metrics Kit from scratch.

System Requirements

• Node.js 18.17 or later
• pnpm (recommended), npm, or yarn
• Git for cloning the repository

Step 1 — Clone the Repository

Use the private repository URL from your purchase confirmation email:

git clone <your-repo-url> saas-metrics-kit
cd saas-metrics-kit

Step 2 — Install Dependencies

pnpm install

This installs Next.js 16, React 19, Tailwind CSS v4, shadcn/ui components, Recharts, and all utility libraries.

Key Dependencies

Package	Purpose
next 16.x	React framework
react 19.x	UI library
tailwindcss 4.x	CSS framework with oklch tokens
@base-ui/react	Accessible UI primitives
recharts	Analytics charts (area, bar, line, pie, composed)
lucide-react	Icons
next-themes	Dark mode
sonner	Toast notifications
date-fns	Date utilities

Step 3 — Start the Dev Server

pnpm dev

Visit http://localhost:3000 to see the overview dashboard.

Step 4 — Verify the Setup

Navigate through key pages:

• /dashboard — Overview with KPI cards and charts
• /revenue — MRR/ARR analytics
• /customers — Customer analytics
• /churn — Churn analysis
• /retention — Cohort retention heatmap
• /forecasting — Revenue forecasting
• /manage/customers — Customer management table
• /manage/subscriptions — Subscription management
• /settings — General settings
• /login — Authentication

Available Scripts

Command	Description
pnpm dev	Start dev server
pnpm build	Create production build
pnpm start	Run production server
pnpm lint	Run ESLint checks

Integrating into an Existing Project

1. Copy components/ into your project (ui, analytics, shared, layout directories)
2. Copy data/seed.ts and types/index.ts
3. Copy design tokens from app/globals.css
4. Install the required dependencies from package.json
5. Wire up seed data to your actual billing provider or data warehouse

Note: All pages use seed data from data/seed.ts. Replace with your own data source (Stripe API, database, analytics platform) when integrating.

Troubleshooting

Port 3000 already in use:

pnpm dev --port 3001

TypeScript errors after installation:

npx tsc --noEmit

Check that tsconfig.json path aliases match your project structure.