# Use and adapt ZaneAI

Use the documented interfaces and source layout for **ZaneAI**. The sections below retain the README’s examples and configuration details.

## Development Commands

| Command | Action |
| :--- | :--- |
| `npm run start` | Start the mobile application. |
| `npm run convex` | Run the Convex dev server and codegen. |
| `npm run typecheck` | Run TypeScript validation across the monorepo. |
| `npm run lint` | Execute ESLint checks. |
| `npm run portal:build` | Build the Portal Next.js app. |
| `npm run web:build` | Build the Web Next.js app. |
| `npm run agent:smoke` | Run AI agent smoke tests. |

---

## Repository Architecture

This is a high-performance monorepo managed with **npm workspaces**, designed for speed, modularity, and cross-platform consistency.

### Applications (`apps/`)

| Path | Project | Description | Tech Stack |
| :--- | :--- | :--- | :--- |
| [`/apps/mobile`](https://github.com/apps/mobile) | **Zane Mobile** | The companion app for modern agents. | Expo, React Native |
| [`/apps/portal`](https://github.com/apps/portal) | **Zane Portal** | High-fidelity institutional interface. | Next.js, Framer Motion |
| [`/apps/web`](https://github.com/apps/web) | **Zane Web** | Client-facing interactive experience. | Next.js, Tailwind CSS |

### Infrastructure & Shared Core (`packages/`)

- **[`/convex`](https://github.com/convex)**: The AI-native backend. Real-time subscriptions, serverless functions, and vector search.
- **[`/packages/ag-ui`](https://github.com/packages/ag-ui)**: The "Pure Canvas" design system. High-precision primitives for web and mobile.
- **[`/packages/zayon-assistant-protocol`](https://github.com/packages/zayon-assistant-protocol)**: Unified communication layer for AI interactions.

---

## Commands in the root manifest

The captured [package.json](https://github.com/Up-to-code/ZaneAI/blob/HEAD/package.json) declares the following scripts. Run them from the directory containing that manifest.

| Command | Script |
| --- | --- |
| `npm run start` | `npm --workspace apps/mobile run start` |
| `npm run android` | `npm --workspace apps/mobile run android` |
| `npm run ios` | `npm --workspace apps/mobile run ios` |
| `npm run typecheck` | `npm --workspace apps/mobile run typecheck` |
| `npm run test` | `npm --workspace apps/mobile run test` |
| `npm run lint` | `npm --workspace apps/mobile run lint` |

## Troubleshoot a local change

1. Reproduce the smallest example from the [quick-start guide](/docs/up-to-code-zaneai/quick-start-guide).
2. Compare required configuration and dependency versions with the README.
3. Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/ZaneAI)
- [Original README](https://github.com/Up-to-code/ZaneAI/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/ZaneAI/issues)
- [Open the project website](https://zane-ai-portal.vercel.app)