| **Languages** | Kotlin or Java source files |
| **UI toolkits** | Jetpack Compose, classic XML Views, or both |
| **Architectures** | MVVM, MVI, Clean Architecture (full layer structure) |
| **Build systems** | Gradle Kotlin DSL (with version catalog) or Groovy DSL |
| **SDK levels** | Min / target / compile SDK from API 21 to 35 |
| **13 toggleable features** | ViewModel, Coroutines, Hilt, Navigation, Material 3, Room, Retrofit, DataStore, Coil, CameraX, WorkManager, Biometrics, **Firebase Auth** |
| **UI languages** | English, Afrikaans, Español, Français, Português, isiZulu |
| **LLM Agent** | Built-in agent panel powered by your own API key — OpenAI, Anthropic, Google Gemini, Groq, OpenRouter, DeepSeek, Mistral, xAI, or any OpenAI-compatible endpoint |

Every toggle changes the generated output: Gradle dependencies, manifest permissions, version catalog entries, and real Kotlin/Java source files (view models, repositories, DAOs, DI modules, an `AuthManager` for Firebase, etc.).

## 🧭 Documentation

| Document | Purpose |
|---|---|
| [`USER_MANUAL.md`](USER_MANUAL.md) | End-user guide: every screen, setting, and workflow |
| [`AGENT_GUIDE.md`](AGENT_GUIDE.md) | Setting up the BYOK LLM agent with each provider |
| [`DISCLAIMERS.md`](DISCLAIMERS.md) | Full legal disclaimers and limitation of liability |
| [`CHANGELOG.md`](CHANGELOG.md) | Release history |

## 🏗️ Architecture of this app

- **Next.js 16** (App Router) + **React 19** + **TypeScript**
- **shadcn/ui** + **Tailwind CSS 4** for the interface
- **Zustand** for state, **Zod** for validation
- 4 generation API routes (`templates`, `versions`, `preview`, `download`) + 1 LLM proxy route (`agent/chat`)
- JSZip for server-side ZIP packaging
- No database required — the whole app is stateless

## ⚠️ Important disclaimers (short version)

> **This software is provided "as is", without warranty of any kind.** Generated projects are starting points, not production-reviewed applications — you must review, test, and secure any code before shipping it. Not affiliated with Google, Firebase, or any model provider. The LLM agent uses **your own API keys** and you are responsible for the resulting usage costs. See [`DISCLAIMERS.md`](DISCLAIMERS.md) for the full text.

## 📄 License

Proprietary — © Selius (PTY) Ltd. All rights reserved. See [`LICENSE.md`](LICENSE.md).

---

*Android Scaffold is a Microz product, an initiative of Selius (PTY) Ltd.*