Sync Repo-README from project files
69
Repo-README.-.md
Normal file
69
Repo-README.-.md
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- codex-wiki-sync:5340b4fa0608716d65c4b47d -->
|
||||
|
||||
> Mirrored from `/mnt/DATA/git/govoplan-addresses/README.md`.
|
||||
> Origin: `repository`.
|
||||
> Active tasks and changing state belong in Gitea issues; this wiki page is durable project context.
|
||||
|
||||
---
|
||||
# GovOPlaN Addresses
|
||||
|
||||
<!-- govoplan-repository-type:start -->
|
||||
**Repository type:** module (domain).
|
||||
<!-- govoplan-repository-type:end -->
|
||||
|
||||
`govoplan-addresses` is the reusable address and recipient-source module. It
|
||||
owns long-lived address directories and makes them available to campaigns,
|
||||
mail, forms, reporting, portal, and postbox modules through platform
|
||||
capabilities.
|
||||
|
||||
The campaign module may import campaign-local recipient tables, but reusable
|
||||
address management belongs here.
|
||||
|
||||
## Current State
|
||||
|
||||
The first extracted WebUI contribution owns `/address-book` and provides the
|
||||
mock personal/group/tenant address-book workspace that previously lived inside
|
||||
`govoplan-campaign`.
|
||||
|
||||
## Boundary
|
||||
|
||||
`govoplan-addresses` owns:
|
||||
|
||||
- Adrema-style person, organization, household, and postal-address records
|
||||
- reusable email address lists and postal-letter recipient views
|
||||
- segments and reusable recipient-source definitions
|
||||
- consent, legal-basis, and communication-preference metadata
|
||||
- deduplication, merge, and address quality workflows
|
||||
- import/export of reusable address directories
|
||||
- source provenance and change history
|
||||
|
||||
It must not own:
|
||||
|
||||
- campaign-local recipient snapshots
|
||||
- delivery queues or send attempts
|
||||
- SMTP/IMAP transport
|
||||
- file storage
|
||||
- global identity authentication or RBAC evaluation
|
||||
|
||||
## First Capability
|
||||
|
||||
The first useful contract should be a read-only recipient-source capability,
|
||||
for example `addresses.recipientSource`.
|
||||
|
||||
It should let a consumer request a stable snapshot containing:
|
||||
|
||||
- source id and display label
|
||||
- normalized recipient rows
|
||||
- email and postal address fields
|
||||
- legal-basis and consent metadata
|
||||
- source update marker
|
||||
- provenance fields suitable for audit and campaign reports
|
||||
|
||||
Consumers must store their own immutable snapshot when they need historical
|
||||
evidence. The addresses module remains the owner of the reusable source, not of
|
||||
the consumer's historical records.
|
||||
|
||||
## Design Documents
|
||||
|
||||
- [Address module architecture](docs/ADDRESS_MODULE_ARCHITECTURE.md)
|
||||
- [Implementation plan](docs/IMPLEMENTATION_PLAN.md)
|
||||
Reference in New Issue
Block a user