Skip to content

Commit 0f890d7

Browse files
Merge pull request #11 from Task-Manager-Pro/codex/criar-fluxograma-de-explicação-do-projeto
Add architecture flow documentation
2 parents 46e92c7 + 1e8b859 commit 0f890d7

3 files changed

Lines changed: 38 additions & 0 deletions

File tree

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Ignore build outputs
2+
bin/
3+
obj/
4+
*.user
5+
*.db
6+
*.db-shm
7+
*.db-wal
8+
Todo.Tests/bin/
9+
Todo.Tests/obj/
10+
# Ignore VS folder
11+
.vs/
12+
# ignore local environment files
13+
app.db*

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ git clone https://github.com/Romulo-Queiroz/todoListFront
2929
| :-------------------------------------------------------------------------------------------------------------------------------------: |
3030

3131
</div>
32+
33+
## Architecture Diagram
34+
See [docs/architecture.md](docs/architecture.md) for a high level flow of how the API handles requests.

docs/architecture.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Project Flow
2+
3+
The diagram below summarizes how requests are processed in the Task Manager API.
4+
5+
```mermaid
6+
flowchart TD
7+
Client((Client)) -->|HTTP request| Controller[Controllers]
8+
Controller --> Service[Services]
9+
Service --> Dal[DAL]
10+
Dal --> Db[(Database)]
11+
Service -->|Returns data| Controller
12+
Controller -->|JSON| Client
13+
```
14+
15+
Each layer has a specific responsibility:
16+
17+
- **Controllers** handle HTTP requests and responses.
18+
- **Services** contain business logic.
19+
- **DAL (Data Access Layer)** interacts with the database via Entity Framework Core.
20+
- **Database** stores tasks, categories, and users.
21+
22+
Use this diagram to explain the flow of information through the application.

0 commit comments

Comments
 (0)