From dcddae2c32a974e3fbe289248eee58e311708e34 Mon Sep 17 00:00:00 2001 From: Rick Date: Tue, 30 Sep 2025 17:12:35 +0800 Subject: [PATCH 1/2] Update README with data model and ERD Added a data model section with an ERD diagram. --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d8fb738..11c2cc5 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,43 @@ note: you can use `docker` instead of `podman` as it is a drop in replacement ## Tests 1. make sure main dependencies are installed 2. run `poetry install` -2. run `pytest`, take note that it uses `.env.test` for configuration \ No newline at end of file +2. run `pytest`, take note that it uses `.env.test` for configuration + +## Data Model + +```mermaid +--- +config: + layout: dagre + look: handDrawn +title: ERD +--- +erDiagram + direction LR + person { + int id PK "" + String last_name "" + String first_name "" + String country_code FK "" + timestamp updated_at "" + timestamp created_at "" + } + country { + String code PK "" + String name "" + int phone "" + String symbol "" + String capital "" + String currency "" + String continent_code FK "" + String alpha_3 "" + timestamp updated_at "" + timestamp created_at "" + } + continent { + String code PK "" + String name "" + } + person}|--||country:"residesIn" + country}|--||continent:"belongsTo" +``` From 6ca88e6abaa4774cee952955cc4f93ac7c4226dc Mon Sep 17 00:00:00 2001 From: Heinrich Chan Date: Sun, 4 Jan 2026 23:57:47 +0800 Subject: [PATCH 2/2] update readme --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 11c2cc5..6c0a157 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,6 @@ config: title: ERD --- erDiagram - direction LR person { int id PK "" String last_name ""