Initialize GovOPlaN module seed
This commit is contained in:
63
README.md
Normal file
63
README.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# GovOPlaN Facilities
|
||||
|
||||
`govoplan-facilities` is the GovOPlaN platform module seed for facilities management for buildings, rooms, maintenance, cleaning, keys, access zones, recurring inspections, occupancy, defects, and service contractors.
|
||||
|
||||
This repository is initialized as a discoverable module seed. It exposes a module manifest, initial permissions, role templates, documentation metadata, Gitea workflow templates, and a focused manifest test. It intentionally does not yet add HTTP routes, database models, migrations, or WebUI navigation.
|
||||
|
||||
## Initial Ownership
|
||||
|
||||
- building and room operations
|
||||
- maintenance and cleaning schedules
|
||||
- key and access-zone facts
|
||||
- occupancy metadata
|
||||
- defect records
|
||||
- contractor references
|
||||
|
||||
## Boundaries
|
||||
|
||||
This module does not own:
|
||||
|
||||
- generic bookable resource slots
|
||||
- asset accounting lifecycle
|
||||
- public issue intake
|
||||
|
||||
Detailed boundary notes are in [docs/FACILITIES_DOMAIN_BOUNDARY.md](docs/FACILITIES_DOMAIN_BOUNDARY.md).
|
||||
|
||||
## Integrations
|
||||
|
||||
Expected optional integrations:
|
||||
|
||||
- resources
|
||||
- assets
|
||||
- inspections
|
||||
- contracts
|
||||
- procurement
|
||||
- booking
|
||||
- files
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-facilities
|
||||
```
|
||||
|
||||
Focused manifest verification:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-facilities
|
||||
PYTHONPATH=src:/mnt/DATA/git/govoplan-core/src /mnt/DATA/git/govoplan-core/.venv/bin/python -m unittest discover -s tests
|
||||
```
|
||||
|
||||
## Gitea Workflow
|
||||
|
||||
Issue templates are installed under `.gitea/`, and the shared label taxonomy is copied to `docs/gitea-labels.json` with the module label `module/facilities`.
|
||||
|
||||
From the core checkout, labels can be synced once a local `GITEA_TOKEN` is available:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./scripts/gitea-sync-labels.py --root /mnt/DATA/git/govoplan-facilities --apply
|
||||
```
|
||||
Reference in New Issue
Block a user