Files
govoplan-files/AGENTS.md
2026-07-11 16:49:02 +02:00

1.3 KiB

GovOPlaN Files Codex Guide

Scope

This repository owns the files module: managed file storage APIs, file metadata, shares, uploads/downloads, folder and pattern helpers, backend module manifest, and @govoplan/files-webui.

Core owns auth, tenants, RBAC, database/session primitives, CSRF/API helpers, shared components, and shell layout. Campaign integration must remain optional and go through core module metadata or capabilities.

Local Commands

Install and run through core:

cd /mnt/DATA/git/govoplan-core
./.venv/bin/python -m pip install -r requirements-dev.txt

For combined checks, run:

cd /mnt/DATA/git/govoplan
tools/checks/check-focused.sh

For WebUI permutation checks that include files:

cd /mnt/DATA/git/govoplan-core/webui
PATH=/mnt/DATA/git/govoplan-core/webui/node_modules/.bin:/home/zemion/.nvm/versions/node/v22.22.3/bin:$PATH /home/zemion/.nvm/versions/node/v22.22.3/bin/npm run test:module-permutations

Working Rules

  • Keep files behavior in this module, not core.
  • Do not require campaign or mail imports for files-only startup.
  • Shared WebUI components belong in core; files WebUI should consume them through @govoplan/core-webui.
  • Preserve optional campaign usage tracking through capability/registry boundaries.