initial commit after split
This commit is contained in:
30
README.md
30
README.md
@@ -1,2 +1,32 @@
|
||||
# govoplan-core
|
||||
|
||||
Reusable core components for the Government Operational Platform GovOPlaN.
|
||||
|
||||
This repository owns platform-level contracts and infrastructure that should not be coupled to a consuming product module:
|
||||
|
||||
- backend module manifests and registry validation
|
||||
- server runner integration for routes, metadata and module availability
|
||||
- database session/base primitives and module migration registration
|
||||
- tenant/access/RBAC models and permission evaluation
|
||||
- stable principal DTOs, token helpers and tenant datastore abstractions
|
||||
- shared WebUI package `@govoplan/core-webui` for API/CSRF/auth helpers, core types, generic UI components, login UI and shell layout primitives
|
||||
|
||||
Modules register backend routes, permissions, nav items, frontend package metadata, SQLAlchemy metadata and migration locations through their `govoplan.modules` manifest. The core runner aggregates those contributions and exposes the combined platform.
|
||||
|
||||
## Development
|
||||
|
||||
Install the backend core and module checkouts through the core development environment:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
Install WebUI dependencies from the core WebUI runner, which links the module WebUI packages from the neighboring module repositories:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core/webui
|
||||
PATH=/home/zemion/.nvm/versions/node/v22.22.3/bin:$PATH /home/zemion/.nvm/versions/node/v22.22.3/bin/npm install
|
||||
```
|
||||
|
||||
Production deployments should use tagged git dependencies or published package versions, not runtime file copying.
|
||||
|
||||
Reference in New Issue
Block a user