Skip to content

Dichit Backend Docs

The authoritative reference for the Dichit platform backend.

Operational guides, engineering standards, API contracts, and runbooks for the Fastify + TypeScript service that powers Dichit — v1/v2/v3 REST, WebSocket events, queues, payments, and infrastructure.

Getting started REST reference WebSocket protocol Runbooks

Node.js 24 · TypeScript · Fastify · Prisma/PostgreSQL · Redis · BullMQ · WebSocket · Zod · Pino · AWS · Firebase

flowchart LR
    WEB["Web app (v2)"] --> API
    MOB["Mobile app (v3)"] --> API
    API["dichit-backend"]
    API --> PG[(PostgreSQL)]
    API --> RD[(Redis)]
    API --> S3[AWS S3]
    API --> FCM[Firebase]
    API --> PAY[Zwitch]

Explore the documentation

  • Getting started

Install the toolchain, run the stack locally, and learn the project layout.

Explore

  • Architecture

Clean architecture, dependency flow, request lifecycle, and event-driven design.

Explore

  • API reference

REST endpoints (v1/v2/v3 + webhooks) and the authoritative WebSocket protocol.

Explore

  • Database

Prisma schema, migrations, indexing strategy, and query optimization.

Explore

  • Infrastructure

Redis, WebSocket, Docker, logging, monitoring, AWS, and payments.

Explore

  • Development

Coding standards, DI, validation, auth, error handling, and testing.

Explore

  • Deployment

Environments, CI/CD, release process, and rollback.

Explore

  • Runbooks

Step-by-step incident response for production outages.

Explore

  • ADR library

Architecture decisions and their rationale.

Explore

  • Templates

Copy-paste Markdown templates for features, APIs, services, and runbooks.

Explore

Goal Go to
Run the service locally Local development
Every environment variable Environment variables
Where code lives Project structure
First API call REST overview
Real-time events WebSocket events
Change the database Migrations
Write an API endpoint REST template
Contribute to these docs Documentation guide

How to use this portal

  • Search is available from the top bar — try auction, runbook, or webhook.
  • Use the right-hand table of contents to jump within a page.
  • Every page has an edit link () that opens a PR against docs/ in the backend repo.
  • Dark mode follows your system preference; toggle it from the top bar.

This portal is built with MkDocs Material. The Markdown corpus in docs/ is renderer-neutral, so the portal can move to a standalone dichit-docs repository without editing the content. See Docs portal & operations.