Quickstart

Pick the path that matches how you’re running Alforse.

Alforse Cloud (SaaS)
Self-hosted / local development

Production Alforse Cloud does not have open self-service sign-up — new tenants are opened through an Alforse onboarding process or by redeeming a code, per Plans & Editions.

Get a redemption code

Request a redemption code from your Alforse contact. Codes are tied to a plan (free, team, business, enterprise, or self_hosted).

Redeem it

Go to deals.alforse.com/redeem and submit:

Your code
A tenant (organization) name and URL slug
Your name and email
A password (8+ characters)

This calls POST /api/v1/auth/redeem under the hood — see Authentication if you’re scripting this instead of using the UI.

Sign in at deals.alforse.com with your tenant slug, email, and password. If your plan requires admin MFA, you’ll be prompted to enroll a TOTP authenticator on first login.

Create your first contract

From the dashboard, open Contracts → New Contract to intake a contract manually, or upload a scanned PDF for OCR-assisted extraction (Team plan and above). See Contract Intake.

This is the short version — see Installation for the full explanation of every dependency.

Clone and install

git clone <your-fork-or-mirror-url> alforse
cd alforse
npm install

Start the dev stack

cd apps/api
cp .env.example .env   # then fill in required values, see Configuration
docker compose -f docker-compose.dev.yml up -d

Set up the database

npm run prisma:generate
npm run prisma:migrate
npm run db:seed

Run the API

npm run start:dev

Run a frontend app

From the repo root, in a separate terminal:

export VITE_API_BASE_URL=http://localhost:3000/api/v1
npm run dev              # Deals workspace
# or: npm run console:dev

Create your first tenant

Local registration and redemption both require a valid plan and, in production, a Turnstile token. For local development, use the tenant bootstrap flow documented with your self-hosted distribution package.

npm --workspace @alforse/api run db:seed

Next steps

Core Concepts

API Reference

​Next steps

Core Concepts

API Reference

Next steps