-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add c4-like diagram in Mermaid format (#345)
* Add c4-like diagram in Mermaid format * Use cylinder for db and general cleanup * Add separate DOJ diagram with S3 and backend systems in an agency boundary. * Style DOJ chart
- Loading branch information
1 parent
afbde7f
commit 072e985
Showing
3 changed files
with
81 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Forms Platform - architecture diagram | ||
|
||
```mermaid | ||
flowchart TB | ||
subgraph "External Users" | ||
formFiller[Form Filler: Submits forms] | ||
formCreator[Form Creator: Uses no-code interface to create forms] | ||
formReviewer[Form Reviewer: Reviews submitted forms] | ||
end | ||
subgraph "Forms Platform (Internal)" | ||
webServer[Node.js Web Server: Handles form creation, submission, and interactions] | ||
database[(Postgres DB: Stores form data and user information)] | ||
end | ||
subgraph "External Systems" | ||
loginGov[Login.gov: Handles authentication] | ||
subgraph "Agency Systems" | ||
agencyBackend[Agency Backend Systems: Receives submitted form data] | ||
s3Bucket[Amazon S3: Stores completed forms] | ||
end | ||
end | ||
formCreator -->|Creates forms using| webServer | ||
formFiller -->|Submits forms via| webServer | ||
formReviewer -->|Reviews submitted forms using| webServer | ||
webServer -->|Stores and retrieves form data from| database | ||
webServer -->|Authenticates form creators - https| loginGov | ||
webServer -->|Submits form data to Agency Backend - https| agencyBackend | ||
webServer -->|Uploads form PDFs to S3 Bucket - https| s3Bucket | ||
%% Forcing "External Systems" to be below "Forms Platform" | ||
dummyNode[ ]:::invisible | ||
webServer --> dummyNode | ||
dummyNode --> loginGov | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Forms Platform - DOJ architecture diagram | ||
|
||
Sample diagram of a potential DOJ deployment of the Forms Platform. | ||
|
||
```mermaid | ||
flowchart TB | ||
subgraph "External Users" | ||
formFiller[Form Filler: Submits forms]:::userStyle | ||
formCreator[Form Creator: Uses no-code interface to create forms]:::userStyle | ||
formReviewer[Form Reviewer: Reviews submitted forms]:::userStyle | ||
end | ||
subgraph "DOJ Boundary" | ||
subgraph "Forms Platform (Internal)" | ||
webServer[Node.js Web Server: Handles form creation, submission, and interactions]:::webStyle | ||
database[(Postgres DB: Stores form data and user information)]:::dbStyle | ||
end | ||
subgraph "Agency Systems" | ||
agencyBackend[Agency Backend Systems: Receives submitted form data]:::agencyStyle | ||
s3Bucket[(Amazon S3: Stores completed forms)]:::agencyStyle | ||
end | ||
end | ||
subgraph "External Systems" | ||
loginGov[Login.gov: Handles authentication] | ||
end | ||
formCreator -->|Creates forms using| webServer | ||
formFiller -->|Submits forms via| webServer | ||
formReviewer -->|Reviews submitted forms using| webServer | ||
webServer -->|Stores and retrieves form data from| database | ||
webServer -->|Authenticates form creators via HTTPS| loginGov | ||
webServer -->|Submits form data to Agency Backend via HTTPS| agencyBackend | ||
webServer -->|Uploads form PDFs to S3 Bucket via HTTPS| s3Bucket | ||
classDef userStyle fill:#ffa500,stroke:#000,stroke-width:2px,color:#000; | ||
classDef webStyle fill:#6f6,stroke:#000,stroke-width:2px,color:#000; | ||
classDef dbStyle fill:#f9f,stroke:#333,stroke-width:2px,color:#000; | ||
classDef agencyStyle fill:#cde,stroke:#000,stroke-width:2px,color:#000; | ||
``` |