Skip to content

Commit

Permalink
Added more templating to the architecture diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
janhalen authored Dec 4, 2024
1 parent 4d79870 commit ba08891
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# Example Architecture diagram
# Project Architecture

> Replace this with a brief introduction to the architecture documentation

[Architecture Diagram](#architecture-diagram) | [Components](#components) | [Data Flow](#data-flow)


## Architecture Diagram
> Provide a high level architecture diagram in the [Mermaid](https://mermaid.js.org/intro/getting-started.html) format
```mermaid
flowchart LR
Expand All @@ -7,8 +16,8 @@ flowchart LR
end
subgraph Backend["Backend"]
B1("fa:fa-server API Gateway")
B2("fa:fa-cogs Microservice 1")
B3("fa:fa-cogs Microservice 2")
B2("fa:fa-cogs Service 1")
B3("fa:fa-cogs Service 2")
end
subgraph Storage["Storage"]
C[("fa:fa-database Database")]
Expand Down Expand Up @@ -38,6 +47,27 @@ flowchart LR
style Frontend fill:#FFDDC1,stroke:#FF7043,stroke-width:1px,color:#424242
style Storage fill:#FFE0B2,color:#424242
linkStyle 1 stroke:#616161
```

## Components
> Provide a brief explanation of the main components and their interactions as shown in the diagram <bove>
### Frontend

> Describe the frontend components and their roles in the system.
### Backend

> Detail the backend architecture including APIs and microservices.
### Storage

> Explain the storage solutions used and their configurations.
### Infrastructure Services

> List and describe additional services such as authentication and monitoring.
## Data Flow

```
> Illustrate how data moves through the system from input to output.

0 comments on commit ba08891

Please sign in to comment.