Skip to content

Commit be9f3e2

Browse files
committed
Refactor code structure for improved readability and maintainability
1 parent 147e529 commit be9f3e2

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

.docs/diagram.png

363 KB
Loading

.docs/interface.png

54.8 KB
Loading

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ This project serves as a template or starting point for building secure and scal
1818
* **Modern Tooling:** Utilizes `uv` for dependency management, `Dynaconf` for configuration, and `ruff` for linting/formatting.
1919
* **Testability:** Designed with dependency injection and includes a comprehensive test suite using `pytest`.
2020

21+
22+
## User Interface
23+
24+
Below is a preview of the application's interface:
25+
26+
![User Interface](.docs/interface.png)
27+
2128
## Highlights
2229

2330
* JWT-based authentication (login, refresh tokens).
@@ -30,6 +37,13 @@ This project serves as a template or starting point for building secure and scal
3037
* Comprehensive test suite with `pytest` (including coverage).
3138
* Health check endpoint (`/health`).
3239

40+
41+
## Architecture Diagram
42+
43+
Below is an overview of the application's architecture:
44+
45+
![Architecture Diagram](.docs/diagram.png)
46+
3347
## Technology Stack
3448

3549
* **Python:** >= 3.13

0 commit comments

Comments
 (0)