Quick Start Guide 🚀

The fastest way to get VENI-AI running on your machine.

---

1. Preparation

Ensure you have these installed:

• Docker Desktop (Running)
• Bun (Primary runtime)
• Node.js 20+ (For some UI tools)

---

2. Launch the Platform

Linux / macOS (Recommended)

# 1. Initialize network and infrastructure
./scripts/init-network.sh
./scripts/start-infrastructure.sh

# 2. Start Shell API (New Terminal)
cd shell/api && bun install && bun run db:migrate && bun run seed && bun run dev

# 3. Start Shell UI (New Terminal)
cd shell/ui && npm install --legacy-peer-deps && bun install && npm run dev

Windows

# Right-click root folder -> Open in Terminal
./start-shell.ps1

---

3. Login

1. Open http://localhost:5173
2. Use default developer account:
   • Email: admin@veni.ai
   • Password: admin123

---

4. Create your first App

Once the Shell is running, open a new terminal and run:

# Scaffold a new satellite app
veni create app my-cool-app

# Register it with the Shell
veni register my-cool-app --api-url http://localhost:3014/api --ui-url http://localhost:4177

---

Advanced Configuration

Need to change ports or database settings? See the Full Configuration Reference.