Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 2.79 KB

AGENTS.md

File metadata and controls

34 lines (20 loc) · 2.79 KB

nra-server

Shared server-side library (NestJS + TypeScript + TypeORM) consumed by every NRA project as the server/shared git submodule.

This repo is shared — edit with care

react-admin-nestjs, event-management-nra, teacher-report-nra, student-report-nra, and dnd-management-nra all pin this repo as a submodule. A change here reaches every app the next time it bumps its pointer. Prefer additive, backward-compatible changes. When a change needs each consuming app to do something (new dependency, new config, a Dockerfile/compose edit, a wiring change), it is not automatic — record it (see below).

Full rollout process: the shared-changes-workflow and bump-shared-ref skills in multi-repo-codespace/.github/skills/.

CONSUMER_CHANGES.md convention

CONSUMER_CHANGES.md at the repo root is the handshake between a shared change and the apps that must adapt to it. Maintain it by these rules:

  • Add a row only when a consumer must act. Purely additive changes that work automatically after a pointer bump get no row.
  • When you author such a change, add the row in the same PR. Columns: Commit (short hash, or (docs) for policy-only), Adds, Per-app action (the exact edit), Done in (apps already wired — often none yet).
  • When you wire an app, append it to that row's Done in and commit.
  • A runtime break after a bump with no matching row = a missing row. Add it.

Key shared subsystems

  • utils/report/ — BaseReportGenerator family (Excel/PDF/ZIP/audio/JSON). See the report-generation skill.
  • utils/yemot/ — Yemot IVR handler base (v2), router, and the testing/ scenario harness. See the yemot-integration skill.
  • auth/ — JWT auth, guards, strategies.

Tests

yarn test (Jest + ts-jest). Mock the TypeORM repo/DataSource — no live DB in unit tests (a few specs use in-memory sqlite via utils/yemot/testing/real-data-source.ts). See the write-tests skill.

Tests also run standalone, with no consumer app: .github/workflows/test.yml checks the repo out as server/shared (some specs resolve paths from that layout) and runs yarn install && yarn test. package.json/yarn.lock/jest.config.js/tsconfig.json exist only for that; consumers ignore them and use their own deps. Dependency versions are copied from the consumers, so when a consumer bumps one that the shared code relies on, bump it here too. Standalone, src/db/entities/User.entity maps to the base entities/User.entity.

Task tracking

Every code task is an issue in buzz-code/ops; follow the ops-tracking skill (.github/skills/, symlinked from .claude/skills/): find/create the issue, keep its status:* label current, PR body Fixes buzz-code/ops#N. This repo is public: reference items only as buzz-code/ops#N with a neutral technical description.