Documentation
Read the manual before you buy the machine
Every document below ships in the repository a licence gives you access to. They are published here in full, because the only honest way to sell source code is to let people read how it is put together first.
Start here
- OverviewWhat the product is, what is in the box, and the stack it is built on.
- ArchitectureThe layer rule, the import matrix, the procedure ladder, and the multi-tenant invariants the lint config enforces. Normative — read this one before you judge the rest.
- Code standardsNaming, TypeScript, React, Prisma, and tRPC conventions, plus the definition of done every change is held to.
Building on it
Running it
- Local setupEvery environment variable, which three are required, and what each optional one turns on when you supply it.
- DeploymentGoing to production: the database, the storage bucket, the scheduled jobs, and the checks to run before you point a domain at it.
- UpgradingTaking a new release into a codebase you have already changed, without losing your changes.