# socialgouv/domifa architecture

> Architecture diagram of the GitHub repository socialgouv/domifa, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/socialgouv/domifa
- Repository: https://github.com/socialgouv/domifa

## Overview

DomiFa is a monorepo platform for organizations managing domiciliation and for people without stable housing accessing related services. The principal workflow is organization staff authentication, followed by API operations to create and manage a domiciled person’s record; the API persists domain data and can manage associated documents. Separate Angular portals serve domiciled users, administrators, and statistics users. The tree and README establish the broader product shape; sampled excerpts show selected authentication, record-management, and file-storage relationships, not every subsystem’s wiring.

Main entry points: [`packages/backend/src/database/entities`](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/entities) (PostgreSQL data), [`packages/portail-usagers/src/app`](https://github.com/socialgouv/domifa/tree/master/packages/portail-usagers/src/app) (Resident portal), [`packages/backend/src/usagers/controllers/usagers.controller.ts`](https://github.com/socialgouv/domifa/blob/master/packages/backend/src/usagers/controllers/usagers.controller.ts) (Resident API), [`packages/backend/src/auth`](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/auth) (Authentication API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["User portals"]
  node_frontend["Organization interface"]
  node_resident_portal["Resident portal"]
  node_admin_portal["Admin portal"]
  node_stats_portal["Statistics portal"]
end

subgraph group_api["Backend API"]
  node_auth["Authentication API"]
  node_resident_api["Resident API"]
  node_admin_api["Admin API"]
end

subgraph group_domain["Domiciliation domain"]
  node_structures["Organization records"]
  node_users["User accounts"]
  node_residents["Resident records"]
  node_interactions["Resident interactions"]
  node_documents["Document handling"]
end

subgraph group_platform["Data and services"]
  node_db[("PostgreSQL data")]
  node_file_service["Encrypted file service"]
  node_sms["SMS messaging"]
end

subgraph group_shared["Shared contracts"]
  node_common["Shared models"]
end

node_staff(("Organization staff"))
node_resident(("Domiciled person"))
node_admin(("Administrator"))

node_staff -->|"uses"| node_frontend
node_resident -->|"uses"| node_resident_portal
node_admin -->|"uses"| node_admin_portal
node_admin -->|"uses"| node_stats_portal
node_frontend -.->|"authenticates via"| node_auth
node_resident_portal -->|"authenticates via"| node_auth
node_admin_portal -->|"authenticates via"| node_admin_api
node_stats_portal -->|"authenticates via"| node_admin_api
node_frontend -->|"uses contracts"| node_common
node_resident_portal -->|"uses contracts"| node_common
node_admin_portal -->|"uses contracts"| node_common
node_stats_portal -->|"uses contracts"| node_common
node_staff -.->|"manages records"| node_resident_api
node_resident_portal -.->|"records interactions"| node_interactions
node_auth -->|"checks credentials"| node_users
node_auth -->|"blacklists tokens"| node_db
node_resident_api -->|"updates records"| node_residents
node_resident_api -.->|"manages documents"| node_file_service
node_resident_api -->|"deletes SMS records"| node_db
node_documents -.->|"serves documents"| node_file_service
node_file_service -.->|"stores metadata"| node_db
node_admin_api -.->|"manages organizations"| node_structures
node_admin_api -.->|"manages accounts"| node_users
node_residents -.->|"persists records"| node_db
node_structures -.->|"persists records"| node_db
node_users -.->|"persists accounts"| node_db

click node_frontend "https://github.com/socialgouv/domifa/tree/master/packages/frontend/src/app"
click node_resident_portal "https://github.com/socialgouv/domifa/tree/master/packages/portail-usagers/src/app"
click node_admin_portal "https://github.com/socialgouv/domifa/tree/master/packages/portail-admins/src/app"
click node_stats_portal "https://github.com/socialgouv/domifa/tree/master/packages/portail-stats/src/app"
click node_auth "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/auth"
click node_resident_api "https://github.com/socialgouv/domifa/blob/master/packages/backend/src/usagers/controllers/usagers.controller.ts"
click node_admin_api "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/modules/portail-admin"
click node_structures "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/structure"
click node_users "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/user-structure"
click node_residents "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/usager"
click node_interactions "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/modules/interactions"
click node_documents "https://github.com/socialgouv/domifa/blob/master/packages/backend/src/modules/structures/controllers/structure-doc.controller.ts"
click node_db "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/entities"
click node_file_service "https://github.com/socialgouv/domifa/blob/master/packages/backend/src/util/file-manager/file-manager.service.ts"
click node_sms "https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/message-sms"
click node_common "https://github.com/socialgouv/domifa/tree/master/packages/common/src"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_frontend,node_resident_portal,node_admin_portal,node_stats_portal toneBlue
class node_auth,node_resident_api,node_admin_api toneAmber
class node_structures,node_users,node_residents,node_interactions,node_documents toneMint
class node_db,node_file_service,node_sms toneRose
class node_common,node_staff,node_resident,node_admin toneIndigo
```

## Components

### User portals

- [Organization interface](https://github.com/socialgouv/domifa/tree/master/packages/frontend/src/app): `packages/frontend/src/app`
- [Resident portal](https://github.com/socialgouv/domifa/tree/master/packages/portail-usagers/src/app): `packages/portail-usagers/src/app`
- [Admin portal](https://github.com/socialgouv/domifa/tree/master/packages/portail-admins/src/app): `packages/portail-admins/src/app`
- [Statistics portal](https://github.com/socialgouv/domifa/tree/master/packages/portail-stats/src/app): `packages/portail-stats/src/app`

### Backend API

- [Authentication API](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/auth): `packages/backend/src/auth`
- [Resident API](https://github.com/socialgouv/domifa/blob/master/packages/backend/src/usagers/controllers/usagers.controller.ts): `packages/backend/src/usagers/controllers/usagers.controller.ts`
- [Admin API](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/modules/portail-admin): `packages/backend/src/modules/portail-admin`

### Domiciliation domain

- [Organization records](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/structure): `packages/backend/src/database/services/structure`
- [User accounts](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/user-structure): `packages/backend/src/database/services/user-structure`
- [Resident records](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/usager): `packages/backend/src/database/services/usager`
- [Resident interactions](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/modules/interactions): `packages/backend/src/modules/interactions`
- [Document handling](https://github.com/socialgouv/domifa/blob/master/packages/backend/src/modules/structures/controllers/structure-doc.controller.ts): `packages/backend/src/modules/structures/controllers/structure-doc.controller.ts`

### Data and services

- [PostgreSQL data](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/entities): `packages/backend/src/database/entities`
- [Encrypted file service](https://github.com/socialgouv/domifa/blob/master/packages/backend/src/util/file-manager/file-manager.service.ts): `packages/backend/src/util/file-manager/file-manager.service.ts`
- [SMS messaging](https://github.com/socialgouv/domifa/tree/master/packages/backend/src/database/services/message-sms): `packages/backend/src/database/services/message-sms`

### Shared contracts

- [Shared models](https://github.com/socialgouv/domifa/tree/master/packages/common/src): `packages/common/src`

### Other components

- **Organization staff**
- **Domiciled person**
- **Administrator**

## Connections

- Organization staff → Organization interface: uses (evidence: `README.md`)
- Domiciled person → Resident portal: uses (evidence: `README.md`)
- Administrator → Admin portal: uses (evidence: `README.md`)
- Administrator → Statistics portal: uses (evidence: `README.md`)
- Organization interface → Authentication API: authenticates via
- Resident portal → Authentication API: authenticates via (evidence: `packages/portail-usagers/src/app/modules/usager-auth/services/usager-auth.service.ts`)
- Admin portal → Admin API: authenticates via (evidence: `packages/portail-admins/src/app/modules/admin-auth/services/admin-auth.service.ts`)
- Statistics portal → Admin API: authenticates via (evidence: `packages/portail-stats/src/app/modules/auth/services/portail-stats-auth.service.ts`)
- Organization interface → Shared models: uses contracts (evidence: `README.md`)
- Resident portal → Shared models: uses contracts (evidence: `packages/portail-usagers/src/app/modules/usager-auth/services/usager-auth.service.ts`)
- Admin portal → Shared models: uses contracts (evidence: `packages/portail-admins/src/app/modules/admin-auth/services/admin-auth.service.ts`)
- Statistics portal → Shared models: uses contracts (evidence: `packages/portail-stats/src/app/modules/auth/services/portail-stats-auth.service.ts`)
- Organization staff → Resident API: manages records
- Resident portal → Resident interactions: records interactions
- Authentication API → User accounts: checks credentials (evidence: `packages/backend/src/auth/structures-auth.controller.ts`)
- Authentication API → PostgreSQL data: blacklists tokens (evidence: `packages/backend/src/auth/structures-auth.controller.ts`)
- Resident API → Resident records: updates records (evidence: `packages/backend/src/usagers/controllers/usagers.controller.ts`)
- Resident API → Encrypted file service: manages documents (evidence: `packages/backend/src/usagers/controllers/usagers.controller.ts`)
- Resident API → PostgreSQL data: deletes SMS records (evidence: `packages/backend/src/usagers/controllers/usagers.controller.ts`)
- Document handling → Encrypted file service: serves documents
- Encrypted file service → PostgreSQL data: stores metadata
- Admin API → Organization records: manages organizations
- Admin API → User accounts: manages accounts
- Resident records → PostgreSQL data: persists records
- Organization records → PostgreSQL data: persists records
- User accounts → PostgreSQL data: persists accounts
