Introduction
Add quests, rewards and fan accounts to any React app.
The FanBase SDK puts fan accounts, quests and rewards inside your own product. Sign in, complete a quest, claim a reward. All of it rendered by your components.
There is no FanBase UI to accept and no iframe. The packages ship logic, state and unstyled primitives. Everything a fan sees is yours.
Start here
Quickstart
Provider, sign-in, and a live quest list.
Installation
Registry auth, the alpha tag, peer deps.
Integrate with an agent
Two prompts to paste, then review the diff.
How it fits together
The layer model and the quest state machine.
What is live today
A fan signs in with Discord, Google, X or Twitch, sees the quests you configured, completes one, and claims the reward. That path is live and every page here covers it.
Battlepass, predictions, store, newsfeed and leaderboard are not in the package. Feature status tracks each one.
Popular topics
Quest detail
The main build. One view, every template.
Rewards and claims
Reward slugs, claim payloads, lootbox polling.
Display strings
Why INACTIVE must never reach a fan.
Your design system
asChild, and what to take from the SDK.
Two packages
| Package | What it is |
|---|---|
@xborglabs/fanbase-core | Framework-free logic. API client, quest state machine, template registry, reward resolution, string catalog. |
@xborglabs/fanbase-react | React bindings. Provider, hooks, and slot-based components that render your markup. |
Core has no React dependency, so a Vue or Svelte binding is possible later. React is the only one that exists today.
Built to be read by a coding agent
Most partners hand these docs to Claude, Cursor or Codex and review the diff. That is the intended path. The package ships the files an agent reads:
node_modules/@xborglabs/fanbase-react/llms.txt
node_modules/@xborglabs/fanbase-react/quest-templates.md
node_modules/@xborglabs/fanbase-react/quest-description.md
node_modules/@xborglabs/fanbase-react/quest-rewards.md
node_modules/@xborglabs/fanbase-react/prompt.md
node_modules/@xborglabs/fanbase-react/skills/fanbase/SKILL.mdllms.txt is the entry point. The whole site is also at /llms.txt
and /llms-full.txt. A first integration usually takes under
half an hour.
Every page also works read top to bottom without an agent.
Getting access
Two things, one on each side. From us, a community provisioned on the platform
and its environment values. From you, a GitHub token with read:packages on the
@xborglabs org. Installation covers both.