Skip to content

Getting started

Quick Start

Start both services and explore the fictional workspace.

Buyer documentation is provided in English.

Start the Lite API

In a terminal at the template root, start the API. It loads its synthetic dataset automatically; no database, Redis, migration, or seed command is required.

bash
cd portal-api/lite
cp .env.example .env
make run

Start the portal

In a second terminal at the template root, start the portal. The example environment already points NEXT_PUBLIC_API_URL at http://localhost:8080/api/v1. Change it if your API runs elsewhere.

bash
cd portal
pnpm install --frozen-lockfile
cp .env.example .env.local
pnpm dev

Open http://localhost:3000. Choose a role button on the login screen to fill the public fictional credentials, then sign in. Platform controls are visible to the administrator. Use fictional information only; changes are shared within the demo workspace.

RoleEmailPassword
Recruiter / organization ownerdemo@hireiq.testdemo1234
Platform administratoradmin@hireiq.testadmin1234
Use GET /health to verify that the Lite API is running. Mutations are process-local and reset on restart.