Getting started
If you’re new on the team, read these four pages in order. They cover the mechanics — what to install, how to open a PR, how previews work, how the docs stay in sync with the code. You can be productive after about an hour.
| # | Page | What it gets you |
|---|---|---|
| 1 | Local setup | The platform running on your laptop. Docker + Infisical + a fresh DB. |
| 2 | Your first PR | Branch naming, commit message style, picking a PR template, opening the PR. |
| 3 | Deploy previews | The two GitHub labels that spin up a live preview environment for your PR. |
| 4 | Keeping docs in sync | The pre-push hook + CI check + /docs-update skill that catch undocumented business-logic changes. |
What this section is not
- It is not the architecture tour. For “how the platform thinks,” read Overview and Business logic. Those are the framework-agnostic explanations of members, currency, bookings, and the rules the platform enforces.
- It is not the per-component runbook. Each deployable (API, WWW, Admin, Mobile) has its own zone for implementation notes.
- It is not a reference. The deep-dive material lives in Infra → GitHub: every workflow, every label, every PR template documented for when you need to look one up.
The four pages here are deliberately short — the goal is a working mental model on your first day, not exhaustive coverage.
Already onboarded?
You can probably skim the headings of Your first PR and Deploy previews to make sure your habits match the team’s, then move on.
Last updated on