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

# Quickstart

> Run your first clickproof test in about five minutes.

## Before you start

Create a free account at [clickproof.app](https://clickproof.app) and have
an app build ready: an `.apk` for Android, or a simulator `.app.zip` for iOS.

## From the dashboard

<Steps>
  <Step title="Create a project">
    In the dashboard, create a project and pick its platform (Android or iOS).
    A project groups one app's builds and tests.
  </Step>

  <Step title="Describe a test">
    Add a test and write what it should do in plain English, for example:

    > Open the app, complete the sign-up flow, and reach the home screen. It
    > passes when the main home screen is visible.

    clickproof turns this into a plan automatically.
  </Step>

  <Step title="Upload a build">
    On the project's Mobile tab, upload your `.apk` or `.app.zip`. One project
    can hold both.
  </Step>

  <Step title="Run the test">
    Hit **Run**. The agent drives a real cloud device, and within a couple of
    minutes you get a **verdict + video report**.
  </Step>
</Steps>

## From CI (recommended)

Once a project has tests, wire clickproof into your pipeline so every pull
request is tested automatically.

<Steps>
  <Step title="Create an API key">
    In the dashboard, go to **Integrations → GitHub** and create an API key.
    Add it to your repository as a secret named `CLICKPROOF_API_KEY`
    (*Settings → Secrets and variables → Actions*).
  </Step>

  <Step title="Add the workflow">
    Commit this as `.github/workflows/clickproof.yml`:

    ```yaml theme={null}
    name: Mobile E2E
    on: [pull_request]

    jobs:
      clickproof:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v4

          # …your build step that produces an .apk…

          - uses: clickproof-ai/run-tests@v1
            with:
              api-key: ${{ secrets.CLICKPROOF_API_KEY }}
              project: your-project-id
              build: path/to/app.apk
    ```
  </Step>

  <Step title="Open a pull request">
    The Action uploads the build, runs the project's tests, and posts a results
    table to the job summary — **failing the check if any test fails**.
  </Step>
</Steps>

<Note>
  Find your project id in the dashboard URL: `clickproof.app/projects/<id>`.
</Note>

Next: read the [GitHub Actions guide](/ci-cd/github-actions) or the
[API reference](/api-reference/introduction).