Skip to content

Update README with data model and ERD #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heinrich10 merged 2 commits into from
Jan 4, 2026
Merged

Update README with data model and ERD #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcddae2
Update README with data model and ERD
heinrich10 Sep 30, 2025
6ca88e6
update readme
heinrich10 Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,42 @@ 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
2. run `pytest`, take note that it uses `.env.test` for configuration

## Data Model

```mermaid
---
config:
layout: dagre
look: handDrawn
title: ERD
---
erDiagram
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"
```