From 1e8b85993e564b7f1ab2149a82b0f6272b7cd557 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=B4mulo=20Queiroz?= Date: Wed, 25 Jun 2025 19:42:57 -0300 Subject: [PATCH] Add architecture diagram documentation --- .gitignore | 13 +++++++++++++ README.md | 3 +++ docs/architecture.md | 22 ++++++++++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 .gitignore create mode 100644 docs/architecture.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..abfb43e --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +# Ignore build outputs +bin/ +obj/ +*.user +*.db +*.db-shm +*.db-wal +Todo.Tests/bin/ +Todo.Tests/obj/ +# Ignore VS folder +.vs/ +# ignore local environment files +app.db* diff --git a/README.md b/README.md index 5da9255..8334ca6 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,6 @@ git clone https://github.com/Romulo-Queiroz/todoListFront | :-------------------------------------------------------------------------------------------------------------------------------------: | + +## Architecture Diagram +See [docs/architecture.md](docs/architecture.md) for a high level flow of how the API handles requests. diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..1ed5a0b --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,22 @@ +# Project Flow + +The diagram below summarizes how requests are processed in the Task Manager API. + +```mermaid +flowchart TD + Client((Client)) -->|HTTP request| Controller[Controllers] + Controller --> Service[Services] + Service --> Dal[DAL] + Dal --> Db[(Database)] + Service -->|Returns data| Controller + Controller -->|JSON| Client +``` + +Each layer has a specific responsibility: + +- **Controllers** handle HTTP requests and responses. +- **Services** contain business logic. +- **DAL (Data Access Layer)** interacts with the database via Entity Framework Core. +- **Database** stores tasks, categories, and users. + +Use this diagram to explain the flow of information through the application.