Initialize GovOPlaN module seed
This commit is contained in:
64
README.md
Normal file
64
README.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# GovOPlaN Grants
|
||||
|
||||
`govoplan-grants` is the GovOPlaN platform module seed for grant and funding program workflows for applications, eligibility, awards, milestones, payout claims, reporting duties, and audits.
|
||||
|
||||
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
|
||||
|
||||
- funding programs
|
||||
- grant applications
|
||||
- eligibility checks
|
||||
- award records
|
||||
- milestones
|
||||
- payout claims
|
||||
- reporting duties
|
||||
|
||||
## Boundaries
|
||||
|
||||
This module does not own:
|
||||
|
||||
- payment execution
|
||||
- general case management
|
||||
- audit log storage
|
||||
|
||||
Detailed boundary notes are in [docs/GRANTS_DOMAIN_BOUNDARY.md](docs/GRANTS_DOMAIN_BOUNDARY.md).
|
||||
|
||||
## Integrations
|
||||
|
||||
Expected optional integrations:
|
||||
|
||||
- approvals
|
||||
- cases
|
||||
- files
|
||||
- payments
|
||||
- ledger
|
||||
- reporting
|
||||
- audit
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-grants
|
||||
```
|
||||
|
||||
Focused manifest verification:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-grants
|
||||
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/grants`.
|
||||
|
||||
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-grants --apply
|
||||
```
|
||||
Reference in New Issue
Block a user