> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lynkz.elipseday.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Clone, Configure, and Deploy Lynkz in Under 10 Minutes

> Follow this step-by-step guide to clone Lynkz, set up Firebase and Resend, run locally, and deploy your own PIN-protected link-in-bio page to Vercel.

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.

<Steps>
  <Step title="Clone and Install">
    Clone the Lynkz repository from GitHub and install its dependencies.

    ```bash theme={null}
    git clone https://github.com/harshilarora250/lynkz
    cd lynkz
    npm install
    ```
  </Step>

  <Step title="Configure Environment">
    Copy the example environment file and fill in your credentials.

    ```bash theme={null}
    cp .env.example .env.local
    ```

    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](/setup/firebase) guide for step-by-step instructions.
    * **Resend** — An API key for magic link PIN recovery emails (optional, but recommended). See the [Resend Setup](/setup/resend) guide.
  </Step>

  <Step title="Run Locally">
    Start the development server and confirm everything is working.

    ```bash theme={null}
    npm run dev
    ```

    Open [http://localhost:3000](http://localhost:3000) in your browser. You should see the Lynkz home page. Navigate to `/dashboard` to create your first page.
  </Step>

  <Step title="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](/setup/deploy) guide for full instructions, including how to add all required environment variables to your Vercel project.
  </Step>
</Steps>

<Note>
  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.
</Note>

<Tip>
  Ready to create your page right now? Head straight to the live dashboard at [https://lynkz.elipseday.xyz/dashboard](https://lynkz.elipseday.xyz/dashboard) — no local setup required.
</Tip>