Skip to main content

​
Quickstart

Get PIPELINE up and running in under 10 minutes. This guide covers the essential setup to start tracking jobs immediately.
For detailed installation instructions including database migrations and advanced configuration, see the Installation guide.

​
Prerequisites

Before starting, ensure you have:
  • Bun runtime installed (bun.sh)
  • A Supabase account (supabase.com)
  • Git for cloning the repository
PIPELINE uses Bun as the JavaScript runtime. If you prefer npm/yarn/pnpm, they should work but Bun is recommended for optimal performance.

​
Step 1: Clone the Repository

git clone https://github.com/yourusername/pipeline.git
cd pipeline

​
Step 2: Install Dependencies

bun install
This installs all required packages including Next.js, Supabase client, shadcn/ui components, and development dependencies.

​
Step 3: Set Up Supabase Project

1

Create a new Supabase project

  1. Go to supabase.com/dashboard
  2. Click New Project
  3. Choose a name (e.g., “pipeline-jobs”)
  4. Generate a secure database password
  5. Select a region close to you
  6. Click Create new project
Save your database password! You’ll need it for direct database access later.
2

Get your API credentials

Once your project is ready:
  1. Go to Settings → API
  2. Copy your Project URL
  3. Copy your anon public key
  4. Copy your service_role key (click “Reveal” first)
Keep these handy for the next step.
3

Configure environment variables

Copy the environment template:
cp .env.example .env.local
Open .env.local and fill in your Supabase credentials:
# Required - Supabase
NEXT_PUBLIC_SUPABASE_URL=https://YOUR_PROJECT_REF.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_anon_key_here
SUPABASE_SERVICE_ROLE_KEY=your_service_role_key_here

# Application
NEXT_PUBLIC_APP_URL=http://localhost:3000

​
Step 4: Apply Database Migrations

PIPELINE includes 14 database migrations that set up tables, indexes, Row-Level Security policies, and triggers.

​
Step 5: Start the Development Server

bun run dev
The app will start at http://localhost:3000.

​
Step 6: Create Your Account

1

Sign up

  1. Open http://localhost:3000
  2. Click Sign Up
  3. Enter your email and password
  4. Click Create Account
2

Confirm your email

Check your inbox for a confirmation email from Supabase. Click the confirmation link.
For local development, you can skip email confirmation by enabling “Disable Email Confirmations” in Supabase Dashboard → Authentication → Settings.
3

Log in

Return to the app and log in with your credentials.

​
Step 7: Track Your First Job

Congratulations! You’re now ready to track jobs.
1

Open the Tracker

Click Tracker in the sidebar or press ⌘1.
2

Add a job

Press ⌘N or click the Add Job button.Fill in the job details:
  • Title - Job title (e.g., “Senior Backend Engineer”)
  • Company - Company name
  • Location - Where the job is located
  • URL - Link to the job posting
  • Status - Current status (Saved, Applied, Interview, Offer, Rejected)
  • Salary - Salary range (optional)
  • Notes - Any additional notes
Click Save.
3

Explore the interface

Try these keyboard shortcuts:
  • ⌘K - Open command palette
  • ⌘2 - View Dashboard
  • ⌘3 - View Jobs list
  • ⌘4 - View Intel
  • ⌘, - Open Settings
  • ⌘/ - View all shortcuts

​
What’s Working Now

PIPELINE is under active development. Here’s what you can use today: ✅ Full authentication - Sign up, log in, password reset
✅ Job tracking - Add, edit, delete jobs
✅ Kanban board - Drag-and-drop between statuses
✅ List view - Sort and filter jobs
✅ Job drawer - Detailed view with notes and timeline
✅ Command palette - Keyboard-first navigation
✅ Settings - Profile, account, preferences ⚠️ In Progress:
  • Dashboard analytics (displays mock data)
  • AI match scoring
  • Job board scraping
  • Discord notifications
  • Export functionality

​
Next Steps

Installation Guide

Detailed setup including database schema, TypeScript types, and advanced configuration.

Configuration

Configure AI services, integrations, and feature flags.

Architecture

Understand how PIPELINE is built and organized.

API Reference

Explore the API endpoints and data models.

​
Troubleshooting

​
Port 3000 Already in Use

# Use a different port
bun run dev -- --port 3001

​
Supabase Connection Errors

Double-check your .env.local file:
  • Ensure no extra spaces around the = signs
  • Verify you copied the full API keys
  • Make sure you’re using the anon key for NEXT_PUBLIC_SUPABASE_ANON_KEY
This means database migrations weren’t applied. Go back to Step 4 and apply migrations using either the CLI or dashboard method.
This usually happens if:
  • Migrations weren’t fully applied (missing RLS policies)
  • You’re not properly authenticated
  • Try logging out and back in

​
Development Server Won’t Start

# Clear Next.js cache
bun run clean

# Reinstall dependencies
rm -rf node_modules bun.lock
bun install

# Try again
bun run dev

​
Getting Help

If you encounter issues:
For production deployment, see the Deployment Guide for instructions on deploying to Vercel, Netlify, or self-hosted environments.

Build docs developers (and LLMs) love

Get started for freeTalk to us