Skip to content

Installation

Prerequisites

Ensure you have the following installed:

ToolVersionPurpose
Node.js>= 18.xRuntime
npm>= 9.xPackage manager
GitLatestVersion control

Optional but recommended:

ToolPurpose
Supabase CLILocal database development and migrations
N8NLocal workflow automation testing

Quick Start

1. Clone the Repository

bash
git clone https://github.com/Slazerslaze/pip-ai.git
cd pip-ai

2. Install Dependencies

bash
npm install

3. Configure Environment

Copy the example environment file and fill in your credentials:

bash
cp .env.example .env

See the Environment Variables guide for details on each variable.

4. Start Development Server

bash
npm run dev

The application will be available at http://localhost:3000.

5. Dev Auth Bypass (Optional)

For local development without configuring Supabase Auth, enable the dev bypass:

ini
NUXT_PUBLIC_DEV_AUTH_BYPASS=true

This skips authentication checks and uses a mock user session.

Supabase Setup

  1. Create a project at supabase.com
  2. Copy the Project URL and anon key to your .env
  3. Run migrations using the Supabase SQL editor (see Database Migrations)

Local (Advanced)

bash
# Install Supabase CLI
npm install -g supabase

# Start local Supabase instance
supabase start

# Apply migrations
supabase db push

Verify Installation

After starting the dev server:

  1. Open http://localhost:3000
  2. You should see the PIP AI dashboard
  3. If using dev auth bypass, you'll be automatically logged in
  4. Try creating a test project to verify database connectivity

Troubleshooting

Common Issues

Port 3000 in use:

bash
npx nuxi dev --port 3001

Module resolution errors after install:

bash
npm run postinstall  # Runs nuxt prepare

Supabase connection failures:

  • Verify your SUPABASE_URL and SUPABASE_KEY in .env
  • Check that the Supabase project is active and not paused
  • Ensure RLS policies are applied (see Database docs)

Built with VitePress