Technical Reference

Complete technical reference for Offworld's architecture, APIs, and systems.

Reference Documentation

Tech Stack Summary

Frontend

• TanStack Start - SSR React framework
• TanStack Router v1 - Type-safe routing
• shadcn/ui - 50+ UI components
• Tailwind CSS v4 - Utility-first styling

Backend

• Convex Cloud - Serverless backend
• Convex Workflows - Durable workflows
• @convex-dev/rag - Vector search
• @convex-dev/agent - AI agent framework

AI/ML

• Gemini 2.5 Flash Lite - Analysis LLM
• Gemini 2.0 Flash Exp - Chat LLM
• Google Text Embedding 004 - RAG embeddings

Auth

• Better Auth - Modern auth framework
• GitHub OAuth - Social login

Quick Reference

Key Files

Frontend:

• apps/web/src/router.tsx - Router config
• apps/web/src/routes/ - File-based routes

Backend:

• packages/backend/convex/schema.ts - Database schema
• packages/backend/convex/workflows/ - Durable workflows
• packages/backend/convex/agent/ - AI agent

Common Patterns

Query Data:

const repo = useQuery(api.repos.getByFullName, { fullName });

Mutate Data:

const start = useMutation(api.repos.startAnalysis);
await start.mutateAsync({ fullName });

Run Action:

const getOwner = useAction(api.github.getOwnerInfo);
const data = await getOwner({ owner });

For Developers

• Building features? → Developer Guide
• Setting up locally? → Project Setup
• Understanding workflows? → Backend Architecture