Skip to content

CLAUDE.md

Latest commit

 

History

History
51 lines (40 loc) · 2.83 KB

CLAUDE.md

File metadata and controls

51 lines (40 loc) · 2.83 KB

BX Team Monorepo

This is the BX Team monorepo — it contains all BX Team projects, both frontend and backend. When entering a project, either to edit or analyse, you should read it's CLAUDE.md.

Architecture

  • Monorepo tooling: bun workspaces (package.json with workspaces field). Run scripts across packages with bun run --filter '<pattern>' <script>.
  • Frontend: Vue 3 / Nuxt 4, Tailwind CSS v4
  • Backend: Hono (Ingest API), Nuxt Nitro (Downloads API, Auth, Pulsify API), BullMQ worker (cinder), Postgres, Clickhouse, Redis
  • Formatting: Biome is the source of truth — 2-space indent for TS/JS/JSON and standalone CSS. Tabs are used only inside .vue <template> and <style> blocks (Biome doesn't reformat those). Run bunx biome check . before committing.

Apps (apps/)

App Description
cinder BullMQ worker for ingest API
influx Ingest API written in Hono
meridian Main BX Team frontend app (Nuxt 4)
zenith Status monitor (like Better Uptime)

Packages (packages/)

Package Description
stratus Database schemas (Drizzle ORM)
types Shared TypeScript types (Zod schemas)
ui Shared UI components (Vue 3, Tailwind)

Project-Specific Instructions

Each project may have its own CLAUDE.md with detailed instructions:

Code Guidelines

Comments

  • DO NOT use "heading" comments like: === Helper methods ===.
  • Use doc comments, but avoid inline comments unless ABSOLUTELY necessary for clarity. Code should aim to be self documenting!

Bash Guidelines

Output handling

  • DO NOT pipe output through head, tail, less, or more
  • NEVER use | head -n X or | tail -n X to truncate output
  • IMPORTANT: Run commands directly without pipes when possible
  • IMPORTANT: If you need to limit output, use command-specific flags (e.g. git log -n 10 instead of git log | head -10)
  • ALWAYS read the full output — never pipe through filters

General

  • Do not create new non-source code files (e.g. Bash scripts, SQL scripts) unless explicitly prompted to
  • For Frontend, when doing lint checks, always use Biome (e.g. biome check .) instead of ESLint or other linters
  • When provided problems, do not say "I didn't introduce these problems" (shifting the blame/effort) - just fix them.