> ## 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.

# Lynkz: Open-Source Link-in-Bio, No Sign-Up Required

> Lynkz is a link-in-bio platform that lets you create a public profile page secured with a PIN. No sign-up, no email, no account needed.

Lynkz is an open-source link-in-bio platform that gives you a public profile page at `lynkz.elipseday.xyz/username` — no account, no email, and no sign-up required. You protect your page with a PIN, manage your links from a dashboard, and share a single URL with your audience. That's it.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Clone, configure, and deploy your own Lynkz instance in under 10 minutes.
  </Card>

  <Card title="Firebase Setup" icon="fire" href="/setup/firebase">
    Create a Firebase project and configure Firestore for your deployment.
  </Card>

  <Card title="Features" icon="stars" href="/features/dashboard">
    Explore analytics, themes, link scheduling, export, and more.
  </Card>

  <Card title="Security" icon="shield-halved" href="/security/pin-authentication">
    Learn how PIN hashing, IP lockouts, and sensitive field stripping keep your page safe.
  </Card>
</CardGroup>

## What is Lynkz?

A link-in-bio page lets you share one URL — typically in a social media bio — that points visitors to everything you want them to see: your links, content, and contact info, all in one place.

With Lynkz, your page lives at `lynkz.app/username` and is publicly accessible to anyone with the URL. You control it through a PIN-protected dashboard — no account creation, no email verification, and no password resets. Just choose a username, set a PIN, and you're live.

Because Lynkz is open source, you can also self-host your own instance on Vercel (or any Node.js host) using your own Firebase project, giving you full ownership of your data.

## Key Features

<CardGroup cols={2}>
  <Card title="PIN Authentication" icon="lock">
    Your dashboard is protected by a SHA-256 hashed PIN with salt. After 3 failed attempts, your IP is locked out for 24 hours.
  </Card>

  <Card title="Analytics" icon="chart-bar">
    Track page views and link clicks server-side. See traffic sources, devices, browsers, and a daily chart for 7, 14, or 30 days.
  </Card>

  <Card title="Themes & Customization" icon="palette">
    Choose from 8 color themes, 3 button styles, and 5 background animations — including Gradient, Bubbles, Mesh, and Wave.
  </Card>

  <Card title="Link Scheduling" icon="calendar">
    Set per-link start and end datetimes. Links outside their active window are automatically hidden on your public page.
  </Card>

  <Card title="Export" icon="download">
    Export your page data as JSON, CSV, or a standalone self-hostable HTML file.
  </Card>

  <Card title="Magic Link Recovery" icon="envelope">
    Set a recovery email in your dashboard settings. If you forget your PIN, request a single-use magic link valid for 15 minutes.
  </Card>
</CardGroup>

## Tech Stack

| Technology             | Role                             |
| ---------------------- | -------------------------------- |
| **Next.js 16**         | App Router + API Routes          |
| **Firebase Firestore** | Database (no Firebase Auth used) |
| **Resend**             | Magic link recovery emails       |
| **Vercel**             | Hosting + serverless functions   |