Developer guide

This guide is for engineers working on Prolifto. It explains how the monorepo fits together, how data flows between the admin and storefront, and which workflows to use when changing the platform.

Reading order

1. Architecture — the system in one page.
2. Local development — run and debug it.
3. Database — schema, migrations, and queries.
4. Authentication and tenancy — users, organizations, roles, and API keys.
5. API and SDK — oRPC, OpenAPI, and the typed client.
6. Testing — unit, integration, and E2E.

Then use the reference pages as needed:

• Payments
• Background jobs
• Storage
• Email
• Feature flags
• Observability
• Deployment
• Backups and restore
• Troubleshooting

How to make a change

1. Read the relevant module and its tests.
2. Change shared contracts in @prolifto/domain first.
3. Update the database schema and generate a migration if needed.
4. Implement server logic in the admin module.
5. Update the UI and the storefront if the change is customer-facing.
6. Add or update tests for critical behavior.
7. Update the docs in the same pull request.
8. Run pnpm check, pnpm check-types, and the relevant tests.

Repository conventions

• TypeScript strict mode; no any when unknown works.
• Biome + Ultracite for formatting and linting.
• Drizzle for all database access.
• Zod schemas for API and form validation.
• Admin modules are vertical slices with server, ui, and hooks.
• Storefront reads catalog data through @prolifto/sdk, not directly from the database.

Need help?

• Check Troubleshooting.
• Search the repository before adding a new abstraction.
• When in doubt, prefer a small change in the existing module over a new package.