# Install and configure ZaneAI

Follow the source instructions for **ZaneAI**. Read the prerequisites and configuration steps before running an example.

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

---

## Check the installation

After setup, continue with the [first example](/docs/up-to-code-zaneai/quick-start-guide). If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

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