Skip to content

Commit 091b947

Browse files
committed
docs: add project architecture diagram to readme
- Added Mermaid flowchart showing movies-ui, movies-api, movies-shell and their connections
1 parent 85b41f0 commit 091b947

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,28 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
2323

2424
`React` frontend application where users can manage movies. All the communication with `movies-api` is over `HTTPS`. It uses [`MUI`](https://mui.com/) as UI component library.
2525

26+
## Project Diagram
27+
28+
```mermaid
29+
flowchart LR
30+
subgraph "movies-ui (React)"
31+
UI["movies-ui\n:3443"]
32+
end
33+
34+
subgraph "movies-api (Spring Boot)"
35+
API["movies-api\n:8443"]
36+
DB[(H2 DB)]
37+
end
38+
39+
subgraph "movies-shell (Spring Boot CLI)"
40+
Shell["movies-shell\nCLI"]
41+
end
42+
43+
UI -->|HTTPS| API
44+
Shell -->|HTTPS| API
45+
API -->|JDBC| DB
46+
```
47+
2648
## Prerequisites
2749

2850
- [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

0 commit comments

Comments
 (0)