Development Guide

How to contribute to the Locus project.

Project Structure

Locus is a monorepo managed with Turborepo and Bun:

locus/
├── apps/
│   ├── api/           # NestJS API server
│   ├── web/           # Next.js dashboard
│   └── www/           # Marketing website
├── packages/
│   ├── cli/           # @locusai/cli — Command-line interface
│   ├── sdk/           # @locusai/sdk — TypeScript SDK
│   ├── telegram/      # @locusai/telegram — Telegram bot
│   ├── shared/        # Shared types and utilities
│   └── ai-sdk/        # AI provider abstraction layer
└── scripts/           # Setup and deployment scripts

---

Setting Up the Development Environment

Prerequisites

• Bun (latest)

• Node.js 18+

• Git

Clone and Install

git clone https://github.com/asgarovf/locusai.git
cd locusai
bun install

Build All Packages

bun run build

Run Type Checking

bun run typecheck

Run Linting

bun run lint

---

Working on Packages

CLI

cd packages/cli
bun run build
# Test locally
node dist/cli.js --help

Telegram Bot

cd packages/telegram
bun run build
# Test locally
node bin/telegram.js

SDK

cd packages/sdk
bun run build

---

Tech Stack

Component	Technology
Monorepo	Turborepo + Bun
API	NestJS + PostgreSQL
Dashboard	Next.js (React)
CLI	TypeScript + Commander-style parsing
SDK	TypeScript
Telegram	Telegraf (Node.js Telegram framework)
AI Providers	Claude CLI, Codex CLI
Testing	Jest