Quick Start Guide

Get IRA FORCE up and running in your development environment in under 10 minutes. This guide covers the essential setup steps to start building with IRA FORCE.

Prerequisites You'll need Node.js 18+, Docker, and Git installed on your machine.

Step 1: Clone the Repository

Start by cloning the IRA FORCE monorepo from GitHub:

Bash

# Clone the repository
git clone git@github.com:iraforce/iraforce-platform.git

# Navigate to the project directory
cd iraforce-platform

# Install dependencies
npm install

Step 2: Configure Environment

Copy the example environment file and configure your local settings:

Bash

# Copy the example environment file
cp .env.example .env

# Generate a new JWT secret
npm run generate:secret

Edit the .env file with your configuration:

Environment Variables

# Database
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/iraforce_dev

# Redis
REDIS_URL=redis://localhost:6379

# JWT Secret (auto-generated)
JWT_SECRET=your-generated-secret-here

# API Configuration
API_PORT=3000
API_HOST=localhost

# Google Maps API (for geofencing)
GOOGLE_MAPS_API_KEY=your-api-key

Step 3: Start Infrastructure

Use Docker Compose to start the required services:

Bash

# Start PostgreSQL and Redis
docker-compose up -d postgres redis

# Verify services are running
docker-compose ps

Step 4: Run Migrations

Initialize the database schema:

Bash

# Run database migrations
npm run db:migrate

# Seed with sample data (optional)
npm run db:seed

Step 5: Start Development Server

Launch the development server:

Bash

# Start the API server
npm run dev

# In a new terminal, start the web app
npm run dev:web

Success! The API is now running at http://localhost:3000 and the web app at http://localhost:3001.

Verify Installation

Test your setup by making an API request:

Bash

curl http://localhost:3000/api/health

# Expected response:
# {"status":"healthy","version":"2.4.1","timestamp":"..."}

Next Steps

Set up Auth Architecture API Docs Deploy