Getting Started

1. Create a Supabase project

Upkeep uses Supabase for auth, storage, and the scheduled health-check functions. Create a free project at supabase.com, then note its project URL and publishable (anon) key from Project Settings → API.

2. Deploy the dashboard

Clone the repository and deploy it to Vercel, Netlify, or any host that runs Next.js:

git clone https://github.com/hasnaintypes/upkeep-app.git
cd upkeep-app
pnpm install

Copy .env.example to .env.local and fill in your Supabase project’s values:

cp .env.example .env.local

NEXT_PUBLIC_SUPABASE_URL=https://<your-project-ref>.supabase.co
NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=<your-publishable-key>

Public env vars

Only these two variables are meant to be public. Anything else — service role keys, notification channel secrets — stays server-only and is never read from a NEXT_PUBLIC_* variable.

Then start the dev server:

pnpm dev

3. Apply the database schema

The database schema lives in supabase/migrations/ and is applied via the Supabase CLI (pinned as a dev dependency, so run it through pnpm rather than a global install):

pnpm supabase login
pnpm supabase link --project-ref <your-project-ref>
pnpm supabase db push
pnpm gen:types    # regenerate src/lib/supabase/types.ts from the live schema

Guided setup wizard

pnpm setup (scripts/setup.mjs) walks through steps 1, 3, and 4 for you — env vars, project link, schema, Edge Function deploys, and cron secrets — and is safe to re-run if it’s interrupted partway through.

4. Deploy the Edge Functions and authenticate the cron jobs

Health checks, notifications, digests, and data retention all run as Supabase Edge Functions on a pg_cron schedule — without this step, the dashboard works but nothing is ever actually checked:

pnpm supabase functions deploy prober --use-api
pnpm supabase functions deploy notifier --use-api
pnpm supabase functions deploy digest --use-api
pnpm supabase functions deploy rollup --use-api
pnpm supabase functions deploy prune --use-api

Each function’s schedule is already committed as a migration, but the secret each one authenticates with can’t be committed — create it once after db push:

pnpm supabase db query --linked "select vault.create_secret('https://<your-project-ref>.supabase.co', 'project_url');"
pnpm supabase db query --linked "select vault.create_secret('<your SUPABASE_SECRET_KEY value>', 'prober_secret_key');"

Missing this step fails silently

Until both secrets exist, every cron job fires on schedule but fails harmlessly (visible via select * from cron.job_run_details order by start_time desc limit 5;) — no projects get checked and no notifications get sent, with no error surfaced in the dashboard.

See README.md for what each function does and optional email (Resend) setup.

5. Create an account and add a project

Sign up from the deployed app, then add your first project from the dashboard: a name, a health-check target, and how often to check it. See Projects & Health Checks for every field’s meaning. Either wait up to a minute for the next prober tick, or open the project and click Run check now for an immediate result.