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

# Get Started with Encore

> Start presenting offers and tracking entitlements in minutes.

## Welcome to Encore

Encore helps you present offers to your users and track their entitlements seamlessly. Get up and running in just a few minutes by following our guided setup process.

<Note>
  The easiest way to get started is through our **Dashboard**, which provides a step-by-step guided experience for setting up your app.
</Note>

***

## Get Started in Three Steps

<Steps>
  <Step title="Create Your Account">
    Visit [dashboard.encorekit.com](https://dashboard.encorekit.com) and create your account.

    You'll gain instant access to the Dashboard where you can manage your apps, configure offers, and access SDK credentials.

    <Tip>
      Use your work email for faster verification and team collaboration features.
    </Tip>
  </Step>

  <Step title="Choose Your Framework and Platforms">
    The onboarding wizard starts by asking **how you're building**:

    1. Pick your **framework** — React Native, Flutter, Kotlin Multiplatform, or Native.
    2. Pick the **platforms** you want to integrate — **iOS**, **Android**, or both. Picking a cross-platform framework pre-selects iOS + Android for you.

    <Note>
      All platforms in a project share the same API keys — you can add more platforms later.
    </Note>
  </Step>

  <Step title="Add Your App">
    Instead of typing your app details by hand, Encore looks them up from the store:

    * **iOS** — paste your **App Store URL** or just the numeric **App Store ID** (e.g. `123456789`). Encore pulls your app's name, icon, and bundle ID from the App Store automatically.
    * **Android** — paste your **Play Store URL** or your **package name** (e.g. `com.your.app`). Encore pulls your app's name and icon from Google Play.

    Encore shows a preview of what it found (you can tweak the name). If the lookup can't find your app, you can enter the name manually and continue.

    <Check>
      Your app is now registered, and your API keys are generated and ready to use.
    </Check>
  </Step>

  <Step title="Follow the Quickstart">
    After the wizard, the Dashboard walks you through a customized **Quickstart** for your stack:

    1. **Install Encore SDK** — add Encore to your project
    2. **Configure Your App** — initialize the SDK with your API key
    3. **Present Offers** — display offers at the right moments
    4. **Link Your Subscription** — connect your store catalog and pick the subscription Encore offers
    5. **Connect Purchase Events** — forward store notifications so Encore can track subscriptions

    <Info>
      The portal tracks your progress and provides code snippets specific to your app's configuration.
    </Info>
  </Step>
</Steps>

***

## Integration Progress

Alongside the Quickstart, the Dashboard shows an **Integration Progress** tracker that confirms your setup end to end. It groups your work into three phases, with a **Connect store** step per platform:

<Steps>
  <Step title="SDK alive">
    Encore confirms the SDK is installed, configured with your API key, and presenting offers.
  </Step>

  <Step title="Entitlements">
    You connect your store catalog (the **Connect store** step) and pick the subscription Encore offers. This is where you [upload your store credentials](/publishers/connect-store-credentials) — an App Store Connect API key for iOS or a Google Play service account for Android — so Encore can auto-sync your products.
  </Step>

  <Step title="Pipeline">
    You forward store notifications (App Store Server Notifications / Google Play Real-Time Developer Notifications) so Encore tracks subscription lifecycle events.
  </Step>
</Steps>

***

## Choose Your Platform

Encore provides SDKs for iOS, Android, and Web platforms. Choose the platform that matches your application:

<Tabs>
  <Tab title="iOS SDK">
    **Perfect for:**

    * Native iOS applications built with Swift
    * SwiftUI or UIKit projects
    * Apps on the Apple App Store

    **Integration Features:**

    * Native SwiftUI views for offer presentation
    * Seamless integration with StoreKit and in-app purchases
    * Support for RevenueCat, Superwall, and other subscription managers
    * Full offline support with automatic sync

    **Get Started:**

    <Card title="iOS Documentation" icon="apple" href="/publishers/ios/quickstart/install">
      Start building with the Encore iOS SDK
    </Card>
  </Tab>

  <Tab title="Android SDK">
    **Perfect for:**

    * Native Android applications built with Kotlin or Java
    * Jetpack Compose or View-based projects
    * Apps on the Google Play Store

    **Integration Features:**

    * Native offer sheet UI with Jetpack Compose
    * Google Play Billing integration with automatic purchase flow
    * Delegate handlers for RevenueCat, Adapty, and other subscription managers
    * Coroutine-based API with fire-and-forget convenience methods

    **Get Started:**

    <Card title="Android Documentation" icon="android" href="/publishers/android/quickstart/install">
      Start building with the Encore Android SDK
    </Card>
  </Tab>

  <Tab title="React Native SDK">
    **Perfect for:**

    * Cross-platform mobile apps built with React Native
    * Apps targeting both iOS and Android from a single codebase
    * Expo and bare React Native projects

    **Integration Features:**

    * Single TypeScript API for both iOS and Android
    * Native bridges to the Encore iOS and Android SDKs
    * EncoreProvider component and useEncoreContext hook
    * Delegate-based purchase flow with RevenueCat, react-native-iap, or custom billing

    **Get Started:**

    <Card title="React Native Documentation" icon="react" href="/publishers/react-native/quickstart/install">
      Start building with the Encore React Native SDK
    </Card>
  </Tab>

  <Tab title="Web SDK">
    **Perfect for:**

    * Web applications (React, Vue, Angular, Next.js, Svelte)
    * Progressive Web Apps (PWAs)
    * Browser-based applications
    * Vanilla JavaScript projects

    **Integration Features:**

    * Framework-agnostic JavaScript/TypeScript SDK
    * Responsive modal interface for all devices
    * Support for React, Vue, Angular, Next.js, Svelte, and vanilla JS
    * CDN or npm installation options

    **Get Started:**

    <Card title="Web Documentation" icon="globe" href="/publishers/web/quickstart/install">
      Start building with the Encore Web SDK
    </Card>
  </Tab>
</Tabs>

<Note>
  All SDKs share the same backend infrastructure and Dashboard. You can manage apps across all platforms from the same account and track analytics together.
</Note>

***

## What You'll Build

By completing the guided setup, you'll be able to:

<CardGroup cols={2}>
  <Card title="Present Offers" icon="gift">
    Show beautifully designed subscription offers to your users at the perfect moment.
  </Card>

  <Card title="Track Entitlements" icon="shield-check">
    Check user subscription status in real-time throughout your app.
  </Card>

  <Card title="Manage Users" icon="users">
    Identify users and sync their subscription data across devices.
  </Card>

  <Card title="View Analytics" icon="chart-line">
    Track conversion rates, revenue, and user behavior in the Dashboard.
  </Card>
</CardGroup>

***

## Need Advanced Configuration?

For advanced setups, detailed technical documentation, and platform-specific guides, refer to our comprehensive documentation:

<Tabs>
  <Tab title="iOS">
    <CardGroup cols={1}>
      <Card title="iOS Documentation" icon="apple" href="/publishers/ios/quickstart/install">
        Detailed guides for Swift Package Manager, SwiftUI/UIKit integration, CI/CD setup, and advanced patterns.
      </Card>
    </CardGroup>

    **iOS documentation includes:**

    * Manual SDK installation with Swift Package Manager
    * CI/CD configuration for Xcode Cloud, GitHub Actions, and other platforms
    * Advanced user management and entitlement tracking
    * Integration guides for RevenueCat, Superwall, and other subscription platforms
    * Complete SDK reference documentation
  </Tab>

  <Tab title="Android">
    <CardGroup cols={1}>
      <Card title="Android Documentation" icon="android" href="/publishers/android/quickstart/install">
        Complete integration guide for Kotlin/Java apps with Jetpack Compose and Google Play Billing support.
      </Card>
    </CardGroup>

    **Android documentation includes:**

    * Gradle installation via GitHub Packages
    * Coroutine-based API with fire-and-forget convenience methods
    * Google Play Billing integration and delegate handlers
    * Jetpack Compose and Activity/Fragment examples
    * User management and entitlement configuration
  </Tab>

  <Tab title="React Native">
    <CardGroup cols={1}>
      <Card title="React Native Documentation" icon="react" href="/publishers/react-native/quickstart/install">
        Complete integration guide for cross-platform React Native apps with native iOS and Android bridges.
      </Card>
    </CardGroup>

    **React Native documentation includes:**

    * npm installation with CocoaPods and auto-linking
    * EncoreProvider component and useEncoreContext hook
    * Delegate-based purchase flow integration
    * RevenueCat and react-native-iap examples
    * Complete SDK reference documentation
  </Tab>

  <Tab title="Web">
    <CardGroup cols={1}>
      <Card title="Web Documentation" icon="globe" href="/publishers/web/quickstart/install">
        Complete integration guide for JavaScript/TypeScript apps including React, Vue, Angular, and vanilla JS.
      </Card>
    </CardGroup>

    **Web documentation includes:**

    * Installation via npm/yarn/pnpm or CDN
    * Framework integration guides (React, Vue, Angular, Svelte)
    * TypeScript type definitions and examples
    * Event-driven architecture for reactive UX
    * Complete SDK reference documentation
  </Tab>
</Tabs>

<Warning>
  **All integrations require SDK credentials.** You must create an account and add your app in the Dashboard to obtain your **Live** (`pk_live_…`), **Test** (`pk_test_…`), and **Secret** (`sk_live_…` / `sk_test_…`) API keys, even when following the detailed documentation. You retrieve these yourself from the Dashboard — no need to contact the Encore team. (Third-party webhook tokens for RevenueCat/Superwall are the exception — those are provisioned by Encore; see the relevant integration guide.)
</Warning>

***

## Need Help?

<AccordionGroup>
  <Accordion title="I don't have access to the Dashboard">
    The Dashboard is available to all Encore customers. If you don't have access:

    1. Visit [dashboard.encorekit.com](https://dashboard.encorekit.com) to create an account
    2. Contact [admin@joinyaw.com](mailto:admin@joinyaw.com) if you encounter any issues during registration

    Your account will be activated immediately upon registration.
  </Accordion>

  <Accordion title="How do I get my SDK credentials?">
    Your API keys are generated automatically when you add an app — there's no need to contact the Encore team. Each project has these keys, shared across all its platforms:

    * **Live** (`pk_live_…`) — publishable, safe to ship in client code (production). This is the key the SDK uses in its `X-API-Key` header.
    * **Test** (`pk_test_…`) — publishable, for staging and local development. Bypasses geo-filtering so you can test offers from any location.
    * **Secret / Server** (`sk_live_…` / `sk_test_…`) — server-side only; used to generate HMAC signatures for authenticated requests. **Never expose it in client code.**

    To retrieve them yourself:

    1. Log in to [dashboard.encorekit.com](https://dashboard.encorekit.com)
    2. Open your project's **Settings → Project API Keys** (the keys are also surfaced during the Quickstart)
    3. Copy the **Live**, **Test**, or **Secret** key you need

    <Note>
      **Third-party webhook tokens are different.** If you forward subscription events through RevenueCat or Superwall, those integrations use a separate webhook token (`rcw_…` / `swl_…`) that Encore provisions for you — see [Using RevenueCat](/publishers/ios/guides/using-revenuecat) or [Using Superwall](/publishers/ios/guides/using-superwall).
    </Note>
  </Accordion>

  <Accordion title="Can I integrate without using the portal's guided setup?">
    Yes, experienced developers can follow our detailed technical documentation for each platform. However, you'll still need to:

    1. Create an account at [dashboard.encorekit.com](https://dashboard.encorekit.com)
    2. Add your app to obtain SDK credentials
    3. Follow the platform-specific documentation:
       * [iOS Documentation](/publishers/ios/quickstart/install) for Swift apps
       * [Android Documentation](/publishers/android/quickstart/install) for Kotlin/Java apps
       * [React Native Documentation](/publishers/react-native/quickstart/install) for React Native apps
       * [Web Documentation](/publishers/web/quickstart/install) for JavaScript/TypeScript apps

    <Note>
      The Dashboard provides the easiest experience with progress tracking and personalized guidance. The detailed documentation is recommended for advanced configurations, CI/CD pipelines, and custom integration scenarios.
    </Note>
  </Accordion>

  <Accordion title="Which platforms does Encore support?">
    Currently, Encore supports:

    * **iOS** (Swift) - Full support with SwiftUI and UIKit
    * **Android** (Kotlin/Java) - Full support with Jetpack Compose and Google Play Billing
    * **React Native** (TypeScript) - Cross-platform support with native iOS and Android bridges
    * **Web** (JavaScript/TypeScript) - Full support with React, Vue, Angular, and vanilla JS

    Check the Dashboard or contact support for the latest platform availability.
  </Accordion>
</AccordionGroup>

***

## Ready to Get Started?

<Card title="Go to Dashboard" icon="rocket" href="https://dashboard.encorekit.com">
  Create your account and start integrating Encore in minutes.
</Card>

<Note>
  **Questions?** Contact our support team at [admin@joinyaw.com](mailto:admin@joinyaw.com) for assistance.
</Note>