From 1958b05f05490c8c676d3fa733afc12ff98cd9d6 Mon Sep 17 00:00:00 2001 From: Nano Taboada <87288+nanotaboada@users.noreply.github.com> Date: Thu, 17 Apr 2025 13:21:30 -0300 Subject: [PATCH] chore: add project structure diagram --- README.md | 8 +++++++- assets/images/Structure.svg | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 assets/images/Structure.svg diff --git a/README.md b/README.md index 58b7d5f..02b1612 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,18 @@ ## Manifesto -> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — Linus Torvalds +> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — [Linus Torvalds](https://web.archive.org/web/20050404020308/http://www.linuxtimes.net/modules.php?name=News&file=article&sid=145) ## About Proof of Concept for a Web API made with [.NET 8](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8) (LTS) and [ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/release-notes/aspnetcore-8.0?view=aspnetcore-8.0). +## Structure + +![Structure](/assets/images/Structure.svg) + +_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._ + ## Start ```console diff --git a/assets/images/Structure.svg b/assets/images/Structure.svg new file mode 100644 index 0000000..5d60969 --- /dev/null +++ b/assets/images/Structure.svg @@ -0,0 +1 @@ + \ No newline at end of file