Skip to main content

Quick Start

Get your local CIG environment running in less than 5 minutes.

1. Prerequisites​

Ensure you are using the latest long-term support versions:

  • Node.js: v22+
  • pnpm: v9+
  • Docker & Docker Compose

2. Install Dependencies​

pnpm install

3. Environment & Configuration​

CIG uses a specialized environment management system called versioning. You must sync and validate your environment before running any applications.

pnpm env:sync      # Synchronize .env files across the workspace
pnpm env:doctor    # Check for missing or invalid environment variables
pnpm env:validate  # Validate the full environment configuration

4. Local Infrastructure​

CIG requires Neo4j and Chroma for graph and semantic retrieval. These are provided via Docker Compose.

docker-compose -f docker-compose.dev.yml up -d

5. Development Servers​

In most cases, you'll want to run the API and the Dashboard.

# In separate terminal windows (or combined via concurrently)
pnpm dev:api
pnpm dev:dashboard

Alternatively, to launch the entire workspace:

pnpm dev:all

6. Local Endpoints​

Once the servers are up, access them here:

  • Landing Page: http://localhost:3000
  • Dashboard: http://localhost:3001
  • API (Public): http://localhost:3003
  • Docs: http://localhost:3004
  • Graph Browser (Neo4j): http://localhost:7474 (if exposed by your local compose file)
  • Graph Mode: open the Dashboard and switch between live and demo