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

# Welcome to EmitKit

> Monitor critical product moments with real-time alerts

## What is EmitKit?

EmitKit is an open-source event streaming and notification platform that monitors critical product moments. Get instant alerts about signups, cancellations, payments, and other pivotal business events - **awareness, not analysis**.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get started in minutes with our quick start guide
  </Card>

  <Card title="Self-Hosting" icon="server" href="/self-hosting/overview">
    Deploy your own EmitKit instance
  </Card>

  <Card title="TypeScript SDK" icon="code" href="/sdk/typescript">
    Official TypeScript/JavaScript SDK with full type safety
  </Card>

  <Card title="API Reference" icon="terminal" href="/api-reference/introduction">
    Explore the complete API documentation
  </Card>
</CardGroup>

## Key Features

<CardGroup cols={2}>
  <Card title="Real-Time Alerts" icon="bell">
    Browser push notifications and mobile PWA support for critical events
  </Card>

  <Card title="Channel Organization" icon="hash">
    Organize events into channels like Slack - payments, signups, cancellations
  </Card>

  <Card title="Webhook Triggers" icon="webhook">
    Automate workflows and integrations when events occur
  </Card>

  <Card title="Developer-Friendly" icon="code">
    TypeScript SDK with autocomplete - setup in under 5 minutes
  </Card>

  <Card title="Self-Hostable" icon="server">
    Deploy on your infrastructure with Vercel or host anywhere
  </Card>

  <Card title="Open Source" icon="github">
    AGPL-3.0 licensed - built on ClickHouse and Tinybird
  </Card>
</CardGroup>

## Quick Example

```typescript theme={null}
import { EmitKit } from '@emitkit/js';

const client = new EmitKit('emitkit_xxxxxxxxxxxxxxxxxxxxx');

// Create an event
await client.events.create({
  channelName: 'payments',
  title: 'Payment Received',
  description: 'User upgraded to Pro plan',
  icon: '💰',
  metadata: {
    amount: 99.99,
    currency: 'USD'
  }
});

// Identify users with aliases
await client.identify({
  user_id: 'user_123',
  properties: {
    email: 'john@example.com',
    name: 'John Doe',
    plan: 'pro'
  },
  aliases: ['john@example.com', 'johndoe']
});
```

## Use Cases

<AccordionGroup>
  <Accordion title="Monitor Business-Critical Events">
    Get instant alerts for signups, trial activations, payment receipts, and cancellations. Stay aware of what's happening in your product without checking dashboards.
  </Accordion>

  <Accordion title="Eliminate Dashboard Fatigue">
    Stop constantly refreshing analytics dashboards. EmitKit pushes critical moments to you in real-time via browser or mobile notifications.
  </Accordion>

  <Accordion title="Automate Workflows">
    Trigger webhooks when important events occur - send Slack messages, update CRMs, or kick off automation workflows.
  </Accordion>

  <Accordion title="Team Awareness">
    Keep your entire team in sync with what's happening. Organize events into channels so everyone sees what matters to them.
  </Accordion>
</AccordionGroup>

## Why EmitKit?

<CardGroup cols={3}>
  <Card title="Awareness, Not Analysis">
    Focus on critical moments, not comprehensive analytics. Know when important things happen without the noise.
  </Card>

  <Card title="Setup in Minutes">
    Install the SDK, get an API key, and start tracking events. No complex configuration or dashboards to learn.
  </Card>

  <Card title="Self-Hosted & Open">
    Deploy on your infrastructure. Full data ownership. Built on battle-tested tech: ClickHouse, PostgreSQL, SvelteKit.
  </Card>
</CardGroup>

## Tech Stack

* **Framework**: [SvelteKit](https://kit.svelte.dev/) with [Svelte 5](https://svelte.dev/)
* **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team/)
* **Event Storage**: [Tinybird](https://www.tinybird.co/) (ClickHouse)
* **Authentication**: [Better Auth](https://www.better-auth.com/)
* **UI Components**: [shadcn-svelte](https://www.shadcn-svelte.com/) + [Tailwind CSS](https://tailwindcss.com/)

## Get Started

<CardGroup cols={2}>
  <Card title="Quick Start Guide" icon="play" href="/quickstart">
    Install the SDK and send your first event in 5 minutes
  </Card>

  <Card title="Self-Hosting Guide" icon="server" href="/self-hosting/overview">
    Deploy your own EmitKit instance with our comprehensive guide
  </Card>
</CardGroup>

## Community & Support

<CardGroup cols={2}>
  <Card title="GitHub" icon="github" href="https://github.com/emitkit">
    Star us on GitHub and contribute to the project
  </Card>

  <Card title="Discussions" icon="comments" href="https://github.com/emitkithq/emitkit/discussions">
    Join the community, ask questions, and share feedback
  </Card>
</CardGroup>