45 lines (31 loc) · 1.97 KB

Contributing to OboApp

Thank you for your interest in contributing!

Quick Start

Choose your development path:

Front-end only (no Java/Docker): Quick Start with MSW - Mock Service Worker for UI development
Full-stack (zero cloud deps): Quick Start with Emulators - Firebase emulators for backend integration
Production setup: Production Setup Guide - Real Firebase/Google Cloud configuration

Project Structure

Monorepo with three main directories:

/web - Next.js application (frontend + API routes)
/ingest - Data pipeline (crawlers, AI processing, geocoding)
/api - Public REST API server (Hono, /v1 routes)

Each has its own .env.local configuration.

Development Resources

AGENTS.md - Required code patterns and standards for AI agents and developers
APM Agent Resources - How agent primitives (instructions, prompts, agents, skills) are managed via APM
Public API - /api/v1 contract, API key auth, and client onboarding
External API Mocks - Mock Gemini, Geocoding, Overpass, Cadastre
Geocoding - Hybrid geocoding system documentation

Code Standards

Follow patterns in AGENTS.md
TypeScript strict mode, named exports, no barrel files
Tailwind theme colors from web/lib/colors.ts - never hardcode
Never use eslint-disable comments - fix the issue instead
Add Vitest tests for new functionality (at least for the pure functions)

Pull Request Process

Fork and create feature branch
Follow AGENTS.md patterns
Add tests for new functionality
Run pnpm test:run in web/, ingest/, and api/
Submit PR with clear description