Documentation Index
Fetch the complete documentation index at: https://docs.fanfare.io/llms.txt
Use this file to discover all available pages before exploring further.
Implementation Guides
Welcome to the Fanfare implementation guides. These step-by-step tutorials show you how to integrate Fanfare into your application for specific use cases.
Guide Categories
Integration Patterns
Choose the right integration pattern for your application architecture:
| Guide | Best For | Complexity |
|---|
| SPA Integration | React, Vue, Angular apps | Beginner |
| SSR Integration | Next.js, Remix, Nuxt apps | Intermediate |
| Headless Integration | Custom UI, mobile apps | Advanced |
| Mobile WebView | iOS/Android WebView apps | Intermediate |
Authentication
Understand how to authenticate consumers in your Fanfare integration:
| Guide | Description | Complexity |
|---|
| Anonymous Consumers | Guest checkout flows | Beginner |
| Identified Consumers | Logged-in user flows | Intermediate |
| Consumer Linking | Converting anonymous to identified | Intermediate |
| JWT Tokens | Server-side authentication | Advanced |
Checkout Integration
Connect Fanfare with your checkout flow:
| Guide | Description | Complexity |
|---|
| Checkout Overview | Understanding checkout flows | Beginner |
| Cart Reservation | Reserving inventory during checkout | Intermediate |
| Payment Processing | Integrating with payment providers | Intermediate |
| Order Completion | Handling order webhooks | Intermediate |
| Guide | Platform | Complexity |
|---|
| Shopify | Shopify stores | Beginner |
| WooCommerce | WordPress/WooCommerce | Intermediate |
| Custom Platform | Custom e-commerce | Advanced |
Use Cases
End-to-end implementation guides for common scenarios:
| Guide | Scenario | Distribution Type |
|---|
| Product Launch | High-demand product release | Queue |
| Flash Sale | Time-limited sale event | Draw (Lottery) |
| Limited Edition | Exclusive item release | Auction |
| Appointment Booking | Service scheduling | Appointment |
| Event Ticketing | Concert/event tickets | Queue + Draw |
Advanced Topics
Deep dives into advanced integration patterns:
| Guide | Topic | Complexity |
|---|
| Webhooks | Server-side event handling | Intermediate |
| Real-time Updates | Live UI updates | Intermediate |
| Error Handling | Robust error management | Advanced |
Prerequisites
Before starting any guide, ensure you have:
- A Fanfare account - Sign up if you don’t have one
- API credentials - Your
organizationId and publishableKey from the dashboard
- Development environment - Node.js 18+ and your preferred package manager
Guide Structure
Each guide follows a consistent structure:
- Overview - What you’ll build and learn
- Prerequisites - Required setup and knowledge
- Step-by-step instructions - Numbered implementation steps
- Code examples - Complete, working code samples
- Testing - How to verify your implementation
- Troubleshooting - Common issues and solutions
- Next steps - Related guides and resources
Quick Start Path
If you’re new to Fanfare, we recommend this learning path:
- Start here: SPA Integration - Basic SDK setup
- Add auth: Anonymous Consumers - Guest flow
- Connect checkout: Checkout Overview - Checkout basics
- Go live: Product Launch - Complete example
Getting Help
