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

# Sample App Generator

> Pre-built sample applications showcasing your API's capabilities

The Sample App Generator lets you create a library of pre-built sample applications that showcase common use cases for your API. Developers can explore, fork, and customize these examples.

## How It Works

<Steps>
  <Step title="You create sample apps">
    Use prompts or build manually to create examples for common use cases.
  </Step>

  <Step title="Developers browse your library">
    A gallery of ready-to-run examples organized by use case.
  </Step>

  <Step title="They fork and customize">
    Developers copy examples and modify them for their needs.
  </Step>
</Steps>

## Key Features

<CardGroup cols={2}>
  <Card title="Curated Examples" icon="star">
    Hand-picked examples that showcase your API's best features.
  </Card>

  <Card title="Multiple Use Cases" icon="grid">
    Cover different scenarios: authentication, data fetching, webhooks, etc.
  </Card>

  <Card title="Fork & Edit" icon="code-fork">
    Developers get their own copy to customize and deploy.
  </Card>

  <Card title="Always Up-to-Date" icon="rotate">
    Update examples when your API changes. All forks stay independent.
  </Card>
</CardGroup>

## Creating Sample Apps

### From the Dashboard

<Steps>
  <Step title="Go to Sample Apps">
    Navigate to **Sample Apps** → **Create New** in your dashboard.
  </Step>

  <Step title="Choose a method">
    * **Generate with AI**: Enter a prompt describing the app
    * **Import from GitHub**: Import an existing repository
    * **Start from scratch**: Build manually in the playground
  </Step>

  <Step title="Configure metadata">
    Add a title, description, and tags for discoverability.
  </Step>

  <Step title="Publish">Make the sample app available in your library.</Step>
</Steps>

### Recommended Sample Apps

Create examples for these common scenarios:

| Category            | Example Apps                                  |
| ------------------- | --------------------------------------------- |
| **Getting Started** | Hello World, Authentication, First API Call   |
| **Core Features**   | CRUD Operations, Pagination, Error Handling   |
| **Use Cases**       | Dashboard, Form Submission, Data Export       |
| **Advanced**        | Webhooks, Real-time Updates, Batch Operations |

## Organizing Your Library

### Tags and Categories

Organize sample apps with tags:

* By feature: `authentication`, `webhooks`, `pagination`
* By framework: `react`, `python`, `node`
* By difficulty: `beginner`, `intermediate`, `advanced`

### Featured Apps

Pin your best examples to the top of the library for new developers.

## Integration

Sample Apps generated can be embedded in the following places:

* **Documentation platforms**: Mintlify, Fern, Astro Starlight, ReadMe, GitBook
* **Websites**: Any existing website or developer portal
* **Post-login experiences**: API portals, dashboards, onboarding flows

## Analytics

Track how developers interact with your sample apps:

* **Views**: How many developers viewed each app
* **Forks**: How many created their own copy
* **Time Spent**: Average time in the playground
* **Popular Apps**: Which examples get the most engagement

Access analytics in **Dashboard** → **Analytics**.

## Best Practices

<AccordionGroup>
  <Accordion title="Cover the basics first">
    Start with simple examples: authentication, first API call, basic CRUD. Then add advanced scenarios.
  </Accordion>

  <Accordion title="Keep examples focused">
    Each sample app should demonstrate one concept well. Don't try to show everything in one app.
  </Accordion>

  <Accordion title="Add clear descriptions">
    Explain what each example does and when developers would use it.
  </Accordion>

  <Accordion title="Update regularly">
    Keep examples current with your API. Outdated samples frustrate developers.
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Guided Sandbox" icon="map" href="/products/guided-sandbox">
    Create step-by-step interactive tutorials.
  </Card>

  <Card title="Customization" icon="palette" href="/integration/customization">
    Brand your sample app library.
  </Card>
</CardGroup>