IAM Accelerator Docs

Getting Started

This page covers what you need to run and log into IAM Accelerator. For full environment setup (PostgreSQL, .env files, Keycloak realm/client configuration), see install_instructions.md in the repository — it is the source of truth for installation.

Prerequisites

  • PostgreSQL running and reachable
  • Keycloak running with the app’s realm/client already configured
  • backend/.env and frontend/.env.local filled in

1. Start the backend

cd backend
npm install
npm run build && npm run migration:run   # first run only
npm run start:dev

The API is served at http://localhost:3000/api/v1.

2. Start the frontend

cd frontend
npm install
npm run dev

Open http://localhost:3001. The root URL (/) redirects to /controls, the Control Library — the one page every authenticated role can reach.

3. Sign in

Sign-in is handled by Keycloak. Which pages and actions you see after logging in depend on the roles your account carries — see Roles & Workflow for the full breakdown. In short:

  • A Firm Administrator account sees the full admin area: Control Library, Clients, and all engagements.
  • An assessor, reviewer, or client viewer account sees only the engagements they’ve been assigned to, at /engagements/:engagementId.

4. First walkthrough

If you’re logging in as a Firm Administrator for the first time on a fresh environment, the Control Library starts empty. A typical first session:

  1. Add Evidence Types and Standards you’ll assess against.
  2. Author Controls and map them to standard clauses and evidence types.
  3. Create a Client and configure its branding.
  4. Create an Engagement for that client, scoping it to pillars and standard versions.
  5. Assign your team to the engagement from its Team tab.
  6. Start assessing — see Evidence Collection, Ratings, and onward.

Running tests

cd backend && npm test
cd frontend && npm test

Production build

# backend
cd backend && npm run build && npm run start:prod

# frontend
cd frontend && npm run build && npm run start