Skip to content

CodeForPhilly/codeforphilly-ng

Repository files navigation

Nuxt + Supabase Project

A web application built with Nuxt 3 and Supabase.

Prerequisites

  • asdf version manager
  • Docker and Docker Compose
  • Node.js 23.9.0 (managed via asdf)

Getting Started

1. Clone the repository

git clone [repository-url]
cd [repository-name]

2. Install Node.js using asdf

asdf install

3. Install dependencies

npm install

4. Set up Supabase

  1. Navigate to the Supabase directory:

    cd supabase
  2. Create your environment file:

    cp .env.example .env
  3. Update the following required variables in .env:

    • POSTGRES_PASSWORD
    • JWT_SECRET
    • DASHBOARD_PASSWORD
    • VAULT_ENC_KEY
  4. Start Supabase services:

    docker compose up -d
  5. Return to the project root:

    cd ..

5. Configure environment variables

  1. Create your root environment file:

    cp .env.example .env
  2. Set SUPABASE_KEY in .env to the ANON_KEY value from supabase/.env

6. Start the development server

npm run dev

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

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build the application
  • npm run generate - Generate static files
  • npm run preview - Preview the build
  • npm run postinstall - Run Nuxt preparation steps

Development Resources

Project Structure

  • /server - Server-side TypeScript configuration
  • /supabase - Supabase configuration and Docker setup
  • /public - Static assets