# Run a first ZaneAI example

Start with the smallest workflow described by the README for **ZaneAI**. Complete [installation and configuration](/docs/up-to-code-zaneai/installation-guide) first.

## Getting Started

### Prerequisites

- [Node.js](https://nodejs.org/) (v20+)
- [npm](https://www.npmjs.com/)
- [Bun](https://bun.sh/) (Optional, for scripts)

### Installation

1. Clone the repository:
   ```bash
   git clone https://github.com/Up-to-code/ZaneAI.git
   cd ZaneAI
   ```

2. Install dependencies:
   ```bash
   npm install
   ```

3. Configure environment variables:
   Copy `.env.example` to `.env.local` and add your Convex/Auth credentials.

4. Start development server:
   ```bash
   npm run convex      # Starts Convex backend
   npm run start       # Starts Mobile / Web workspaces
   ```

---

## Verify your changes

The root manifest provides this check:

```sh
npm run typecheck
```

Read any errors before continuing. Build and type checks verify source consistency; exercise the README example to verify the behavior you need.

## Next task

[Read the usage guide](/docs/up-to-code-zaneai/usage-guide) for the documented components, configuration, and source layout.

## 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)