Getting Started.
The goal of your first day is simple: get the app running locally and ship one small pull request. Everything else you'll pick up by doing. This page is the path from zero access to your first merge.
Get your access
Before you can build anything you'll need a handful of accounts. Most are provisioned through your manager during onboarding — if something's missing, that's the first thing to flag.
| What | For |
|---|---|
GitHub — write access to perkupapp/perkup-app | The monorepo. Everything lives here. |
Google Workspace (@perkupapp.com) | Identity for GCP, this wiki, and most internal tools. |
GCP / Firebase access to perkup-app | Logs, Firestore console, deploys. |
| 1Password | Local secrets are injected from the shared vault — you can't run the app without it. |
| Slack | Where the team coordinates. Join your team channel and the eng channels. |
| Linear | Where work is tracked (ticket IDs look like ENG-1234). |
Get it on your machine
At a high level: clone the repo, install the toolchain, install dependencies, and start the dev environment. The exact versions and one-time setup steps live in the Developer Environment page — follow it once and you're set.
- Clone
perkupapp/perkup-appand check outmain. - Install the pinned Node version, pnpm, and the 1Password CLI.
- Run the dependency install, then start the full local stack with a single command.
- Open the app in your browser and sign in to a local test account.
Ship your first PR
Our whole workflow is built around small, frequent changes. Your first one should be tiny — a copy fix, a small refactor, a test. The point is to walk the full path end to end:
- Branch off
main. - Make the change. Run the local checks (format, lint, typecheck) before you push — see Developer Environment.
- Open a pull request. CI runs automatically; an inline review bot flags anything mechanical.
- Get a review, address comments, merge. Merging to
maindeploys — see How We Ship. - Watch your change reach production. That's the loop you'll repeat every day.
Getting unstuck
- Conventions — the
AGENTS.mdfile in whatever directory you're working in is the local rulebook. Read it before you touch that area. - How something works — read the code. It's the most accurate answer, always.
- How we do something — that's what this Engineering section is for.
- Anything else — ask in your team's Slack channel. Asking early is cheaper than guessing.
Source: repo onboarding conventions (perkup-app/CLAUDE.md) and team practice. Compiled 2026-06-07.