Updated May 13, 2026
7 min read
Getting started with Handover
Create your first project, connect a site with the API key, and verify your client can edit safely from /admin.
This guide is the fastest way to go from a new Handover account to a client site with live editable content.
1) Create a project in the dashboard
In Handover, click Create project and copy the generated API URL and project API key. The dashboard shows the HTTP site domain, for example https://your-app.convex.site, so generated sites call the correct API endpoints.
The project API key connects your site to the correct content store, lock state, Markdown content, and uploaded assets. You can regenerate the key later if needed, but every connected site must then be updated.
2) Add environment variables in your site
Open your generated website project and set the Handover API URL and project API key in environment variables. The CLI creates the correct env file and can write the values during scaffolding.
- Next.js: NEXT_PUBLIC_HANDOVER_API_URL and NEXT_PUBLIC_HANDOVER_API_KEY
- Vite React and TanStack Start: VITE_HANDOVER_API_URL and VITE_HANDOVER_API_KEY
- Astro: PUBLIC_HANDOVER_API_URL and PUBLIC_HANDOVER_API_KEY
pnpm create handover@latest my-client-site
# choose a template, package manager, credentials, install, and git setup3) Verify editing and publish flow
Open /admin/login on your site, sign in with the project password, and update one text field. Confirm the change appears on the live page.
Also test image upload so you know validation and storage limits are visible before handoff.
4) Test lock behavior before launch
Toggle lock in Handover dashboard and confirm your site reflects locked state correctly. Include this in your go-live checklist.
docs/BOILERPLATE_SCAFFOLDING.md