Quickstart

The equity-platform is a one-command Kubernetes stack for running multiple businesses on shared local infrastructure. The hosted onramp does one thing: gives you your own fork of the platform repo and walks you through booting it.

The 30-second version

1. Sign in with GitHub.
2. We fork jaredzwick/equity-platform to your account.
3. Install the equity-console GitHub App on your fork.
4. git clone your fork, then ./local/up.sh.
5. cd console && npm run dev → open localhost:3030.

Prerequisites

• Docker Desktop (or Colima) running
• Node.js 20+
• Homebrew for macOS: brew install kind kubectl helm

How it works

Sign-in triggers a standard GitHub OAuth web flow against our GitHub App. On callback we POST /repos/{upstream}/forks — GitHub creates a fork under your account (or returns the existing one). We store your access token and fork name in an encrypted session cookie and redirect you to /onboarding.

The App install step is separate from sign-in. It grants your local console permission to write YAML back to your fork over the GitHub API. Without it, every provisioning action fails with a 404.

Why we don’t host the whole platform

The console talks directly to a live Kubernetes cluster via the k8s API. Vercel is serverless — no cluster, no persistent connections. We keep sign-in and onboarding on Vercel; everything that touches your cluster stays on your machine. If you want a fully hosted control plane, get in touch.

Troubleshooting

Fork is stuck “preparing”

GitHub fork creation is async — usually <30s, sometimes up to 5 min. If it’s still stuck after that, refresh the onboarding page. If the fork appears on your GitHub account but not here, sign out and back in to refresh the session.

CSRF error after sign-in

Your browser blocked the state cookie (usually strict privacy extensions). Try again in a normal (non-private) window.

Local console shows “GitHub write failed: 404”

The App isn’t installed on your fork. Come back here and use the “Install App” button on /onboarding.