inferonIQ/DocumentationDashboard

inferonIQ Documentation

Everything you need to deploy, configure, and operate the Enterprise Intelligence Platform.

🚀

Quick Start Guide

Get inferonIQ running in under 10 minutes — local dev, Docker, or cloud.

☁️

Deployment Guide

Step-by-step instructions for on-premises, AWS, Azure, GCP, and Kubernetes.

📡

API Reference

Complete reference for all 17 REST API endpoints with request/response schemas.

🏗️

Architecture

System architecture, NL2SQL engine, database schema, and connector framework.

Quick Start

1

Prerequisites

  • Node.js 20+ and npm 9+
  • A Supabase project (or use Docker Compose for fully local dev)
  • API keys for Claude (Anthropic) and OpenAI
2

Clone & Install

git clone <repo-url> inferoniq
cd inferoniq
npm install
3

Configure Environment

cp .env.example .env.local

Edit .env.local with your keys:

NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
ANTHROPIC_API_KEY=sk-ant-...
OPENAI_API_KEY=sk-...
4

Run Database Migrations

# Option A — Supabase CLI (recommended)
supabase db push

# Option B — Docker Compose (fully local)
docker compose up db -d
# Migrations auto-apply from supabase/migrations/
5

Seed Sample Data (optional)

npx tsx scripts/seed-demo-data.ts

Optional — creates a sample customer with invoices, vendors, contracts, and connections for testing.

6

Start the Development Server

npm run dev

Open http://localhost:3000 — you're ready.

Environment Variables

VariableRequiredDescription
NEXT_PUBLIC_SUPABASE_URL✅Supabase project URL
NEXT_PUBLIC_SUPABASE_ANON_KEY✅Supabase anon/public key
SUPABASE_SERVICE_ROLE_KEY✅Supabase service role key (server-side only)
ANTHROPIC_API_KEY✅Claude API key for NL2SQL + document processing
OPENAI_API_KEY✅OpenAI API key for embeddings + GPT-4o Mini
LICENSE_ENFORCEMENT_MODENo"soft" (default) or "hard"

Testing

# Unit tests (Vitest)
npm test

# Watch mode
npm run test:watch

# Coverage report
npm run test:coverage

# End-to-end tests (Playwright)
npm run test:e2e

Next Steps