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.

WhatFor
GitHub — write access to perkupapp/perkup-appThe monorepo. Everything lives here.
Google Workspace (@perkupapp.com)Identity for GCP, this wiki, and most internal tools.
GCP / Firebase access to perkup-appLogs, Firestore console, deploys.
1PasswordLocal secrets are injected from the shared vault — you can't run the app without it.
SlackWhere the team coordinates. Join your team channel and the eng channels.
LinearWhere 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.

  1. Clone perkupapp/perkup-app and check out main.
  2. Install the pinned Node version, pnpm, and the 1Password CLI.
  3. Run the dependency install, then start the full local stack with a single command.
  4. Open the app in your browser and sign in to a local test account.
If the app comes up and you can sign in, you're done with setup. Don't try to understand the whole codebase first — the fastest way to learn it is to make a change and watch what happens.

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:

  1. Branch off main.
  2. Make the change. Run the local checks (format, lint, typecheck) before you push — see Developer Environment.
  3. Open a pull request. CI runs automatically; an inline review bot flags anything mechanical.
  4. Get a review, address comments, merge. Merging to main deploys — see How We Ship.
  5. Watch your change reach production. That's the loop you'll repeat every day.

Getting unstuck

  • Conventions — the AGENTS.md file 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.