Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jezzsantos committed Jun 11, 2024
1 parent afc12ba commit 6b1fda1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Backend API Ready](https://img.shields.io/badge/Status-BackendAPI_Ready-green.svg)](README.md)
[![Backend API ReadyEnough](https://img.shields.io/badge/Status-BackendAPI_Ready_Enough-green.svg)](README.md)
[![Frontend WebApp Under Construction](https://img.shields.io/badge/Status-FrontendUI_UnderConstruction-yellow.svg)](README.md)
[![Build and Test](https://github.com/jezzsantos/saastack/actions/workflows/build.yml/badge.svg)](https://github.com/jezzsantos/saastack/actions/workflows/build.yml)
[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/jezzsantos)
Expand All @@ -20,7 +20,7 @@ Ready to build, test, and deploy into a cloud provider of your choice (e.g., Azu
The codebase demonstrates common architectural styles that you are going to need in your product in the long run, such as:

* [A Modular-Monolith](https://www.thoughtworks.com/insights/blog/microservices/modular-monolith-better-way-build-software) - always build a monolith first, then separate out to micro-services later
* [A Pluggable Modular-Monolith](https://www.thoughtworks.com/insights/blog/microservices/modular-monolith-better-way-build-software) - always build a monolith first, then separate out to micro-services later if you need to
* [Clean Architecture, Onion Architecture, and Hexagonal Architecture](https://medium.com/@edamtoft/onion-vs-clean-vs-hexagonal-architecture-9ad94a27da91) all the same principles - low-coupling, high-cohesion, a shareable and protected domain at the center
* Hosted behind a distributed REST API, or in a CLI, (or in another executable).
* [Domain Driven Design](https://martinfowler.com/bliki/DomainDrivenDesign.html) (with Aggregates and Domain Events) - modeling actual real-world behaviors, not modeling just anemic data
Expand All @@ -38,9 +38,17 @@ This starter template gives you most of the things all SaaS products will need f
## What is in the box?

![Azure](docs/images/Physical-Architecture-Azure.png)

or if you prefer AWS:

![AWS](docs/images/Physical-Architecture-AWS.png)

## How is it structured?

The best experience of the structure of this template is in an IDE like JetBrains Rider, or Visual Studio, or Visual Studio Code (opening the solution file).

![Solution](docs/images/Logical-Structure.png)

## Who is it for?

This starter template is NOT for everyone, nor for EVERY software project, nor for EVERY skill level. We need to say that because all software products are different, there is not one silver bullet for all of them.
Expand Down
Binary file added docs/images/Logical-Structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Sources.pptx
Binary file not shown.

0 comments on commit 6b1fda1

Please sign in to comment.