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

# Introduction

> Discover EngageFabric, the multi-tenant gamification framework. Add XP, levels, quests, leaderboards, and achievements to any app with our REST API.

<Frame>
  <img src="https://mintcdn.com/none-01b345a3/WFBnX5u36dbsHuKA/images/admin-dashboard-preview.png?fit=max&auto=format&n=WFBnX5u36dbsHuKA&q=85&s=776c0ff0d121d7acaf098ff573580a80" alt="EngageFabric Admin Dashboard" style={{ borderRadius: '8px' }} width="2397" height="1484" data-path="images/admin-dashboard-preview.png" />
</Frame>

## What is EngageFabric?

EngageFabric is a **multi-tenant SaaS gamification framework** that helps you add engaging game mechanics to your applications. Whether you're building a learning platform, e-commerce site, fitness app, or any product that benefits from user engagement, EngageFabric provides the infrastructure you need.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running with EngageFabric in under 5 minutes
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Explore our comprehensive REST API documentation
  </Card>

  <Card title="JavaScript SDK" icon="js" href="/sdks/javascript">
    Integrate EngageFabric into your web application
  </Card>

  <Card title="React Components" icon="react" href="/sdks/react">
    Pre-built UI components for React applications
  </Card>
</CardGroup>

## Core Features

### Player Management

Track and manage players across your application with XP, levels, currencies, and lives.

<AccordionGroup>
  <Accordion title="Experience Points (XP)">
    Award XP to players for completing actions. XP accumulates and contributes to level progression.
  </Accordion>

  <Accordion title="Levels">
    Configure level curves (linear, exponential, or custom tables) to create meaningful progression.
  </Accordion>

  <Accordion title="Currencies">
    Support multiple virtual currencies (coins, gems, tokens) with configurable earn and spend rates.
  </Accordion>

  <Accordion title="Lives/Energy">
    Implement energy systems with automatic regeneration for session-based gameplay.
  </Accordion>
</AccordionGroup>

### Quests & Adventures

Create engaging quest systems with multi-step objectives and seasonal adventures.

```javascript theme={null}
// Track quest progress automatically
await engagefabric.events.track({
  name: 'lesson_completed',
  properties: {
    courseId: 'math-101',
    lessonId: 'lesson-5',
    score: 95
  }
});
```

### Leaderboards

Real-time competitive rankings with support for:

* **Global leaderboards** - All players compete together
* **Segmented leaderboards** - Filter by region, tier, or custom segments
* **Time-boxed leaderboards** - Daily, weekly, monthly competitions

### Real-Time Features

WebSocket-powered real-time updates for:

* Live XP and level changes
* Quest progress notifications
* Leaderboard position updates
* Multiplayer lobby state
* Chat messages

## Architecture Overview

EngageFabric uses a modern, scalable architecture:

```mermaid theme={null}
graph LR
    A[Your App] --> B[EngageFabric API]
    A --> C[WebSocket Gateway]
    B --> D[(PostgreSQL)]
    B --> E[(Redis)]
    C --> E
```

<Note>
  EngageFabric is designed for high throughput with sub-200ms API latency (p95) and real-time WebSocket connections.
</Note>

## Use Cases

<CardGroup cols={3}>
  <Card title="EdTech" icon="graduation-cap">
    Gamify learning with XP, badges, and course completion quests
  </Card>

  <Card title="E-Commerce" icon="shopping-cart">
    Loyalty programs with points, tiers, and rewards
  </Card>

  <Card title="Fitness" icon="dumbbell">
    Track workouts, streaks, and competitive challenges
  </Card>

  <Card title="SaaS Products" icon="cloud">
    User onboarding, feature adoption, and engagement
  </Card>

  <Card title="Gaming" icon="gamepad">
    Progression systems, achievements, and multiplayer
  </Card>

  <Card title="Community" icon="users">
    Reputation, badges, and contribution tracking
  </Card>
</CardGroup>

## Getting Help

<CardGroup cols={2}>
  <Card title="Discord Community" icon="discord" href="https://discord.gg/engagefabric">
    Join our community for support and discussions
  </Card>

  <Card title="GitHub Issues" icon="github" href="https://github.com/engagefabric/engagefabric/issues">
    Report bugs or request features
  </Card>
</CardGroup>