Skip to content
Documentation

Getting Started

Your first day, in order: get the repo on your machine, get the app running, get the checks passing, then learn where the deeper docs live. Work top to bottom — each section assumes the one before it succeeded. Where a command is repo-specific, this page leaves a > TODO: for the maintainer to fill in rather than guess.

Prerequisites

Install the toolchain before you clone. You need the language runtimes and the package manager the repo expects, plus Git and an editor.

TODO: List the exact required versions (Node, pnpm, Go, Docker, etc.) and how to install them — link to the team’s preferred version manager.

Clone & install

Clone the repository and install dependencies from the lockfile so your versions match everyone else’s.

TODO: Add the clone URL and the exact install command (for example, the package-manager install command this repo uses).

Run the app locally

Start the app in development mode and confirm it serves. You should be able to open it in a browser and see it render before moving on.

TODO: Add the dev command and the local URL/port the app serves on.

Run tests & checks

Run the same checks CI runs, so you find problems before you push. At minimum this is typecheck, lint, and the unit test suite.

TODO: Add the exact typecheck, lint, and test commands. If there is a single “run everything” task, name it here.

Common day-one tasks

A short list of things most newcomers do in their first day or two, so you don’t have to hunt for them.

  • Create a branch and open your first pull request.
  • Add or edit a component and see it in Storybook.
  • Run the app against local or seed data.

TODO: Link each task to the canonical how-to, or replace with the tasks that actually matter for this repo.

Where to go next

Once the app runs and the checks pass, these are the docs to read next.