Nest Engineering Docs

Repository overview

Structure and key workflows for the monorepo

This monorepo contains data ingestion services, shared libraries, and client applications for Nest.

Layout

  • apps/: client applications (Nest web, Raven desktop).
  • services/: FastAPI and ConnectRPC backend services.
  • jobs/: batch and scheduled pipelines (e.g., scraping).
  • packages/: shared libraries (Python common utilities, generated protos).
  • proto/: protobuf source definitions (Buf workspace).
  • infra/: Terraform for cloud infrastructure.
  • ci/: Cloud Build and deploy pipelines.
  • db/: Liquibase migrations and database scripts.
  • docs/: Fumadocs site for this documentation.
  • scripts/: local dev helpers and tooling.

Core commands

# Install Python workspace dependencies
uv sync --all-packages

# Run a service (example: handler)
uv run --package handler main.py

# Run tests
uv run pytest

# Regenerate protobufs
buf generate

buf generate requires access to buf.build for remote plugins.

Engineering docs

The docs site is hosted at https://engineering.nest.vet and is protected by Cloudflare Zero Trust/Access.

Frontend and client apps

  • Docs site: cd docs && bun install && bun run dev
  • Nest web app: pnpm --dir apps/nest install && pnpm --dir apps/nest dev
  • Raven desktop: cd apps/raven && flutter pub get && flutter run -d macos

Where to go next

Last updated on