Installation
Prerequisites
Ensure you have the following installed:
| Tool | Version | Purpose |
|---|---|---|
| Node.js | >= 18.x | Runtime |
| npm | >= 9.x | Package manager |
| Git | Latest | Version control |
Optional but recommended:
| Tool | Purpose |
|---|---|
| Supabase CLI | Local database development and migrations |
| N8N | Local workflow automation testing |
Quick Start
1. Clone the Repository
bash
git clone https://github.com/Slazerslaze/pip-ai.git
cd pip-ai2. Install Dependencies
bash
npm install3. Configure Environment
Copy the example environment file and fill in your credentials:
bash
cp .env.example .envSee the Environment Variables guide for details on each variable.
4. Start Development Server
bash
npm run devThe 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=trueThis skips authentication checks and uses a mock user session.
Supabase Setup
Cloud (Recommended for Getting Started)
- Create a project at supabase.com
- Copy the Project URL and anon key to your
.env - 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 pushVerify Installation
After starting the dev server:
- Open
http://localhost:3000 - You should see the PIP AI dashboard
- If using dev auth bypass, you'll be automatically logged in
- Try creating a test project to verify database connectivity
Troubleshooting
Common Issues
Port 3000 in use:
bash
npx nuxi dev --port 3001Module resolution errors after install:
bash
npm run postinstall # Runs nuxt prepareSupabase connection failures:
- Verify your
SUPABASE_URLandSUPABASE_KEYin.env - Check that the Supabase project is active and not paused
- Ensure RLS policies are applied (see Database docs)