Skip to main content
By the end of this guide, you’ll have cloned the Lynkz repository, wired up your environment variables, verified everything runs locally, and deployed a production-ready instance to Vercel — all in under 10 minutes.
1

Clone and Install

Clone the Lynkz repository from GitHub and install its dependencies.
2

Configure Environment

Copy the example environment file and fill in your credentials.
Open .env.local and add your Firebase and Resend credentials. You’ll need:
  • Firebase — API key, project ID, and a service account key. See the Firebase Setup guide for step-by-step instructions.
  • Resend — An API key for magic link PIN recovery emails (optional, but recommended). See the Resend Setup guide.
3

Run Locally

Start the development server and confirm everything is working.
Open http://localhost:3000 in your browser. You should see the Lynkz home page. Navigate to /dashboard to create your first page.
4

Deploy to Vercel

When you’re ready to go live, push your repository to GitHub and import it in Vercel, or use the Vercel CLI. Follow the Deploy to Vercel guide for full instructions, including how to add all required environment variables to your Vercel project.
After adding or updating environment variables in your Vercel project settings, always trigger a new deployment for the changes to take effect. Existing deployments do not pick up variable updates automatically.
Ready to create your page right now? Head straight to the live dashboard at https://lynkz.elipseday.xyz/dashboard — no local setup required.