Run a first ZaneAI example

Start with the smallest workflow described by the README for ZaneAI. Complete installation and configuration first.

Getting Started

Prerequisites

• Node.js (v20+)
• npm
• Bun (Optional, for scripts)

Installation

1. Clone the repository:

   Terminal

   ShellCopy

   1git clone https://github.com/Up-to-code/ZaneAI.git
   2cd ZaneAI

2. Install dependencies:

   Terminal

   ShellCopy

   1npm install

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

4. Start development server:

   Terminal

   ShellCopy

   1npm run convex      # Starts Convex backend
   2npm run start       # Starts Mobile / Web workspaces

Verify your changes

The root manifest provides this check:

1npm 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 for the documented components, configuration, and source layout.

Source and help

• GitHub repository
• Original README
• Issues and existing reports
• Open the project website