Getting Started with PacBoiler

Welcome to PacBoiler! This guide will help you set up your local development environment and get the project running in under 10 minutes.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 18+
• A code editor (VS Code recommended)
• Git (optional, for version control)

1. Extract the Project

After purchasing from pacgie.com/pacboiler, extract the ZIP file:

# Navigate to the extracted folder
cd pacboiler
 
# Optional: Initialize Git for version control
git init
git add .
git commit -m "Initial commit from PacBoiler"

Note: The project comes ready to use - no cloning needed! You own the code and can customize it however you like.

2. Install Dependencies

We use npm for package management.

npm install

3. Environment Setup

Copy the example environment file to create your local configuration:

cp .env.example .env.local

Now, open .env.local in your editor. You will see several variables that need to be filled in. Don't worry, we will guide you through getting each of these keys in the following sections:

• Supabase: See Database Setup and Authentication Setup
• LemonSqueezy: See Payments Setup
• Resend: See Email Setup
• Waitlist: See Waitlist Setup
• Upstash (Rate Limiting): See Rate Limiting
• Testing: See Testing Guide

4. Run the Development Server

Once you have configured your environment variables (at least the Supabase ones are required to start), run the dev server:

npm run dev

Open http://localhost:3000 in your browser. You should see the Landing Page! 🎉

Project Structure

Here's a quick overview of the project structure:

pacboiler/
├── src/
│   ├── app/                 # Next.js App Router pages
│   │   ├── (auth)/          # Login/Signup pages
│   │   ├── (dashboard)/     # Protected dashboard pages
│   │   ├── (public)/        # Public pages (Terms, Privacy)
│   │   ├── api/             # API Routes
│   │   └── page.tsx         # Landing Page
│   ├── components/          # React components
│   │   ├── ui/              # Shadcn UI components
│   │   ├── dashboard/       # Dashboard-specific components
│   │   └── landing/         # Landing page components
│   ├── lib/                 # Utilities and client configurations
│   └── types/               # TypeScript definitions
├── supabase/
│   └── migrations/          # Database migrations
└── docs/                    # Documentation (You are here!)

Next Steps

Now that you have the code running, let's set up the backend services.

Step 1: Authentication Setup