# Get Started

Clone the repository, start the full stack, and confirm a working voice
request end to end.

Confirm your machine meets the
[System Requirements](./get-started/system-requirements.md) before starting.

## Step 1: Clone The Repository

```bash
git clone https://github.com/intel-retail/voice-enabled-interactions.git
cd voice-enabled-interactions/smart-kiosk-assistant
```

## Step 2: Pull Images And Start The Stack

```bash
docker compose pull
docker compose up -d
```

All five images are pulled from Docker Hub under the `intel/` namespace at the tag pinned in
[.env](https://github.com/intel-retail/voice-enabled-interactions/blob/main/smart-kiosk-assistant/.env).
Model files and caches live in Docker named volumes, so no extra host directories need to be
created. First startup downloads model assets into those volumes and can take a few minutes.

To rebuild from source instead of pulling, see the
[Build From Source](./get-started/build-from-source.md) guide.

## Step 3: Verify the Stack Is Healthy

```bash
docker compose ps
curl --noproxy '*' http://127.0.0.1:8010/health   # audio-analyzer
curl --noproxy '*' http://127.0.0.1:8011/health   # text-to-speech
curl --noproxy '*' http://127.0.0.1:8020/health   # rag-service
curl --noproxy '*' http://127.0.0.1:8012/health   # kiosk-core
```

Every response should be `{"status": "ok"}`.

## Step 4: Run the Voice Flow

Open the Gradio UI in a browser:

```text
http://127.0.0.1:7860
```

Then:

1. When the browser prompts for microphone permission, click **Allow**.
2. Use the **knowledge base** panel to ingest the bundled sample content,
   or upload your own `.txt` / `.md` files. Sample content is in
   [knowledge-base-samples/](https://github.com/intel-retail/voice-enabled-interactions/tree/main/smart-kiosk-assistant/knowledge-base-samples).
3. Click the microphone button and ask a question that the knowledge base
   can answer (for example, "What are the store hours?").
4. Wait for the assistant card to update with:
   - the transcript of what you said,
   - the streamed answer text,
   - a spoken response that plays back automatically.

## Next Steps

- [How It Works](./how-it-works.md)
- [Configuration](./get-started/configuration.md)
- [Run With Docker Compose](./get-started/run-container.md) /
  [Run On The Host](./get-started/run-standalone.md)
- [API Reference](./api-reference.md)
- [Troubleshooting](./troubleshooting.md)


:::{toctree}
:hidden:

./get-started/system-requirements.md
./get-started/build-from-source.md
./get-started/run-container.md
./get-started/run-standalone.md
./get-started/configuration.md

:::