From 46cad323f5866c10491d79fbf3ed4a29858d9aca Mon Sep 17 00:00:00 2001 From: zemion Date: Sat, 1 Aug 2026 08:56:08 +0200 Subject: [PATCH] Sync Repo-README from project files --- Repo-README.-.md | 79 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 67 insertions(+), 12 deletions(-) diff --git a/Repo-README.-.md b/Repo-README.-.md index 468703d..cfebc53 100644 --- a/Repo-README.-.md +++ b/Repo-README.-.md @@ -1,4 +1,4 @@ - + > Mirrored from `/mnt/DATA/git/govoplan-core/README.md`. > Origin: `repository`. @@ -7,6 +7,10 @@ --- # govoplan-core + +**Repository type:** system (kernel). + + GovOPlaN core is the platform runner and shared foundation. It owns the server entry point, database/session primitives, module discovery, migration orchestration, capability contracts, install/uninstall orchestration, and the shared WebUI shell. Platform and feature behavior is supplied by installed modules. ## Repository ownership @@ -19,6 +23,9 @@ Core owns: - kernel APIs for platform metadata, module lifecycle, health, and development diagnostics - `@govoplan/core-webui`, including login, CSRF/API helpers, shell layout, generic UI components, IconRail, DataGrid, access boundaries, and module route/nav contracts +The shared DataGrid sizing and resize invariants are specified in +[`docs/DATAGRID_SIZING_CONTRACT.md`](docs/DATAGRID_SIZING_CONTRACT.md). + Platform and feature modules own their backend routers, models, migrations, permissions, frontend packages, nav items, and route contributions. Access, tenancy, policy, audit, and admin behavior live in their owning platform @@ -41,18 +48,20 @@ composition rules live in core only where they are stable kernel contracts. ## Backend development -Create or activate the core virtual environment, then install core and sibling modules from this repository: +For whole-product development, create the virtualenv from the meta repository: ```bash -cd /mnt/DATA/git/govoplan-core +cd /mnt/DATA/git/govoplan +python3 -m venv .venv +./.venv/bin/python -m pip install --upgrade pip ./.venv/bin/python -m pip install -r requirements-dev.txt ``` -Run the platform server from core through the module-aware development runner. The default config reads `ENABLED_MODULES` and discovers installed module entry points. Local development defaults to `tenancy,access,admin,policy,audit,campaigns,files,mail,calendar,docs,ops`; set `ENABLED_MODULES` explicitly when testing a smaller module permutation. +Run the platform server from core through the module-aware development runner. The default config reads `ENABLED_MODULES` and discovers installed module entry points. Local development defaults to the modules listed by `govoplan_core.settings.Settings.enabled_modules`, including Views when its package is installed; set `ENABLED_MODULES` explicitly when testing a smaller module permutation. ```bash cd /mnt/DATA/git/govoplan-core -./.venv/bin/python -m govoplan_core.devserver \ +/mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.devserver \ --host 127.0.0.1 \ --port 8000 ``` @@ -61,13 +70,28 @@ For example, to test campaign without files or mail: ```bash cd /mnt/DATA/git/govoplan-core -ENABLED_MODULES=access,campaigns ./.venv/bin/python -m govoplan_core.devserver \ +ENABLED_MODULES=access,campaigns /mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.devserver \ --host 127.0.0.1 \ --port 8000 ``` The runner loads the same `GovoplanServerConfig` as `govoplan_core.server.app:app`, builds the platform registry, and passes core plus enabled module source roots to uvicorn as reload directories. After reinstalling the editable package, the same command is also available as `govoplan-devserver`. +For focused backend work, keep the complete module graph active while watching +only the module being edited. Core/config sources and explicit `--reload-dir` +paths remain watched: + +```bash +/mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.devserver \ + --reload-module calendar \ + --reload-module campaign +``` + +Use `--reload-core-only` when no optional module source tree should trigger a +restart. Omitting both options preserves the broad default and watches every +enabled module. Startup, migration, and compatibility checks still run against +the complete enabled graph whenever the backend restarts. + The default development database is PostgreSQL at `postgresql+psycopg://govoplan_dev@127.0.0.1:5432/govoplan_dev`. Store the password in `~/.pgpass`. To force the disposable SQLite fallback, run with `GOVOPLAN_DEV_DATABASE_BACKEND=sqlite`; that database lives below `runtime/`. Local devserver runs do not require Redis. `CELERY_ENABLED` defaults to `false`, so campaign queue actions update database state without publishing Celery tasks. Use the synchronous send flow for local send tests, or set `CELERY_ENABLED=true` only when a Redis broker and worker are running. @@ -76,12 +100,29 @@ To run the production-like local profile with PostgreSQL, Redis, a Celery worker, explicit module configuration, and persistent local file storage: ```bash -cd /mnt/DATA/git/govoplan-core -scripts/launch-production-like-dev.sh +cd /mnt/DATA/git/govoplan +tools/launch/launch-production-like-dev.sh ``` -See [dev/production-like/README.md](dev/production-like/README.md) for ports, -environment overrides, and cleanup commands. +See `/mnt/DATA/git/govoplan/dev/production-like/README.md` for ports, +environment overrides, and cleanup commands. Core keeps wrapper commands during +the migration, but whole-product profiles are owned by the meta repository. + +## Security audit + +The repository includes a containerized audit toolbox for SAST, secret scanning, +dependency checks, filesystem misconfiguration scans, duplication, and complexity +reports. See [SECURITY_AUDIT.md](docs/SECURITY_AUDIT.md) for the operating model. + +```bash +cd /mnt/DATA/git/govoplan +tools/checks/security-audit/run.sh --mode ci --scope govoplan +tools/checks/security-audit/run.sh --mode full --scope govoplan +``` + +CI runs the `ci` profile in report-only mode and uploads `audit-reports/` as an +artifact. Once the baseline is clean, set `SECURITY_AUDIT_FAIL_ON_FINDINGS=1` +or pass `--strict` locally to turn findings into a failing gate. `govoplan_core.devserver` enables the development bootstrap before loading settings. In dev, startup migrations create or upgrade the schema and the bootstrap creates the default development login if needed. Explicitly setting `DEV_BOOTSTRAP_ENABLED=false` disables this convenience. Production deployments should use migrations and managed database provisioning instead. @@ -89,14 +130,24 @@ To verify the effective runtime paths and bootstrap behavior without starting uv ```bash cd /mnt/DATA/git/govoplan-core -./.venv/bin/python -m govoplan_core.devserver --smoke --no-reload +/mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.devserver --smoke --no-reload ``` The smoke mode prints the effective config, runtime root, database URL, modules, reload state, and bootstrap decision, then creates the ASGI app and runs startup once. -`requirements-dev.txt` links local GovOPlaN module checkouts for development. `requirements-release.txt` installs the packaged modules from tagged git refs for release builds. See [RELEASE_DEPENDENCIES.md](docs/RELEASE_DEPENDENCIES.md). +The meta repository owns whole-product `requirements-dev.txt`, +`requirements-release.txt`, and the root `.env.example` operator template. Core +keeps package metadata and runtime commands. See +[RELEASE_DEPENDENCIES.md](docs/RELEASE_DEPENDENCIES.md). For the install/runtime configuration contract and operator deployment flow, see [DEPLOYMENT_OPERATOR_GUIDE.md](docs/DEPLOYMENT_OPERATOR_GUIDE.md). +For self-hosted config bootstrap and validation: + +```bash +cd /mnt/DATA/git/govoplan-core +/mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.commands.config env-template --profile self-hosted --generate-secrets +/mnt/DATA/git/govoplan/.venv/bin/python -m govoplan_core.commands.config validate --profile self-hosted +``` ## WebUI development @@ -110,6 +161,10 @@ PATH=/home/zemion/.nvm/versions/node/v22.22.3/bin:$PATH /home/zemion/.nvm/versio The local host links sibling module WebUI packages through local file dependencies and Vite filesystem allowances. Release builds should use `webui/package.release.json`, which points WebUI module packages at tagged git refs. See [RELEASE_DEPENDENCIES.md](docs/RELEASE_DEPENDENCIES.md). +Production builds lazy-load enabled module descriptors and enforce initial and +asynchronous JavaScript budgets. See +[WEBUI_BUNDLE_BUDGETS.md](docs/WEBUI_BUNDLE_BUDGETS.md). + ## Module contract Backend modules register through the `govoplan.modules` entry point and return a `ModuleManifest`. A manifest can contribute: