49 lines
2.3 KiB
Markdown
49 lines
2.3 KiB
Markdown
# GovOPlaN Codex Guide
|
|
|
|
## Scope
|
|
|
|
This repository is the platform runner and shared core for GovOPlaN. It owns the server entry point, database/session primitives, auth, tenancy, RBAC, governance, module discovery, migrations, shared WebUI shell, and generic WebUI components.
|
|
|
|
Sibling module repositories usually used with this repo:
|
|
|
|
- `/mnt/DATA/git/govoplan-files`
|
|
- `/mnt/DATA/git/govoplan-mail`
|
|
- `/mnt/DATA/git/govoplan-campaign`
|
|
|
|
Keep module-specific behavior in the owning module. Core may expose stable extension points, capabilities, and shared components, but should not directly import module WebUI pages or require optional module packages for core-only startup.
|
|
|
|
## Local Commands
|
|
|
|
Use targeted commands first:
|
|
|
|
```bash
|
|
cd /mnt/DATA/git/govoplan-core
|
|
./.venv/bin/python -m govoplan_core.devserver --smoke --no-reload
|
|
./.venv/bin/python -m unittest tests.test_module_system
|
|
./.venv/bin/python -m unittest tests.test_api_smoke.ApiSmokeTests.test_mailbox_message_listing_reports_total_count
|
|
```
|
|
|
|
For WebUI checks:
|
|
|
|
```bash
|
|
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:mail-components
|
|
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-capabilities
|
|
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
|
|
```
|
|
|
|
Run the consolidated focused check when a change touches module discovery, optional integrations, shared mail components, or mailbox listing:
|
|
|
|
```bash
|
|
cd /mnt/DATA/git/govoplan-core
|
|
./scripts/check-focused.sh
|
|
```
|
|
|
|
## Working Rules
|
|
|
|
- Prefer `rg`, `sed`, and targeted tests over broad recursive scans or full builds.
|
|
- Avoid DataGrid changes unless explicitly requested; it is intentionally brittle and has known deferred work.
|
|
- Do not add module-to-module imports for optional integrations. Use core registry/capability/module metadata paths.
|
|
- Do not keep generated WebUI test folders in git status; they should be ignored and removable.
|
|
- Do not start persistent dev servers unless the user asks.
|