# BreezeApp-client

**Repository Path**: github_syn/BreezeApp-client

## Basic Information

- **Project Name**: BreezeApp-client
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-12
- **Last Updated**: 2026-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

English | [繁體中文](./docs/i18n/README_zh.md)

# 🤖 BreezeApp Client

Welcome to BreezeApp Client! This is an official reference example demonstrating how to utilize AI capabilities provided by BreezeApp Engine through the EdgeAI SDK. This guide will walk you through adding powerful on-device AI capabilities to your application step by step.

This project is designed for **application developers** who want to add features like chat, text-to-speech, and audio transcription to their apps with a simple and modern API.

## ✨ The Big Picture: App, SDK, and AI Engine

To use the AI capabilities, the BreezeApp ecosystem relies on three components working together:

1.  **Your App**: The user-facing application.
2.  **EdgeAI SDK**: Now available via Maven/JitPack! Just add the dependency, no need to include local modules.
3.  **BreezeApp Engine**: A separate "AI Engine" app that must be installed on the Android device. It handles the heavy lifting of running the AI models.

```mermaid
graph TD
    A["📱 Your App<br/>(with EdgeAI SDK)"]
    B["🧠 BreezeApp Engine<br/>(Separate App)"]

    A -- "Send AIRequest<br>(e.g. EdgeAI.chat())" --> B
    B -- "Return AIResponse" --> A

    style A fill:#E8F5E9,stroke:#4CAF50
    style B fill:#E3F2FD,stroke:#2196F3
```

This decoupled architecture allows you, the app developer, to focus on the UI/UX while the BreezeApp engine manages the complex AI logic.

## 🚀 Get Started: Integration Guide

We have prepared a detailed, step-by-step guide to get you up and running in minutes.

This guide covers:
-   Installing the `BreezeApp Engine`.
-   Integrating the `EdgeAI SDK` (now via Maven/JitPack).
-   Calling AI functions from your code.
-   Best practices for handling UI state and errors.

➡️ **Ready to start building? Head over to the [Client Integration Guide](./android/breeze-app-client/README.md)**

---

### EdgeAI SDK Dependency (Now via Maven/JitPack)

> **⚡️ Quick Start**
>
> 1. In your `settings.gradle.kts`:
>    ```kotlin
>    repositories {
>        google()
>        mavenCentral()
>        maven { url = uri("https://jitpack.io") }
>    }
>    ```
> 2. In your `build.gradle.kts`:
>    ```kotlin
>    dependencies {
>        implementation("com.github.mtkresearch:BreezeApp-engine:EdgeAI-v0.1.4") // please always use the latest version
>    }
>    ```
>
> No more local module includes needed!

We are working on publishing to Maven Central, but JitPack is fully supported and stable.