Getting Started

Installation & Setup

QUMI is primarily a hosted SaaS product. Most tenant users do not install application code. This page covers tenant onboarding, developer local setup, and integration setup.

Availability: QUMI distinguishes Implemented, Controlled release, In review, and Planned. A source route/module is not automatically a generally available feature or stable external API contract.

Tenant onboarding

Provision the tenant and owner.
Assign the approved vertical/template where applicable.
Configure organization identity, locations, timezone and branding.
Add owner/manager/staff memberships and permissions.
Configure resources, services/catalogue, availability and policies.
Enable required modules and plan-gated capabilities.
Configure communications and integration providers.
Validate the public storefront and role journeys.
Import or seed approved starting data.
Complete tenant acceptance before broad customer use.

Developer prerequisites

Node.js 26+
PostgreSQL
npm
backend/frontend environment configuration through local files or secret management

Repository layout

central/
├─ core/backend/      NestJS + Prisma + PostgreSQL
├─ core/frontend/     Next.js + React + Tailwind CSS
├─ core/mobile/       operations/mobile line
├─ mobile/            customer Expo application line
└─ docs/              product/release/evidence history

Backend

cd core/backend
npm install
npm run prisma:generate
npm run start:dev

The backend defaults to port 3001. Schema evolution uses forward Prisma migrations.

Frontend

cd core/frontend
npm install
npm run dev

The current frontend development script starts Next.js on port 5000.

Coordinated build

npm run build

The root build installs backend/frontend dependencies, generates Prisma client code, and builds both application layers.

Canonical API path

/api/v1/*

New clients and integrations should use the versioned prefix rather than legacy unprefixed compatibility paths.