Skip to content

Commit

Permalink
Merge pull request #8 from Adri99x/main
Browse files Browse the repository at this point in the history
fix(update): added techdocs-ref on aws-fullstack-app catalog-info and template and remove README @ docs
  • Loading branch information
keshav1002 authored Jul 15, 2024
2 parents 975e9ac + cde74b5 commit ffecaec
Show file tree
Hide file tree
Showing 15 changed files with 8 additions and 9 deletions.
1 change: 0 additions & 1 deletion architectures/docs/README.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
parent: Decisions
nav_order: 0
nav_order: 1
status: accepted
date: 2024-07-01
consulted: 99x Tech Leads
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## BFF Architecture
### The BFF pattern
The importance of dedicated backends for specific front ends arose when different front-ends started demanding specific backend behavior mainly based on the client platform they were running.
![](./img/architecture_diagrams-bff-pattern.png)
![](../img/architecture_diagrams-bff-pattern.png)

For the implementation of FSP, we have chosen to go with dedicated BFFs for separate MFEs to make it easier for the development teams to work independently. However, as we are utilizing the monorepo pattern, we will still be able to share code and components between different MFEs and BFFs without adding an additional complexity to the development process.

![](./img/architecture_diagrams-bff.png)
![](../img/architecture_diagrams-bff.png)
Above diagram illustrates the BFF architecture for FSP solution captured into the scope.

Here, it allows the BFF to manage sensitive data like access tokens, API keys, connections strings securely in the backend without relying on the frontend.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ The root directory will house several subfolders, each dedicated to a specific a
* **client** - This folder will contain the client-side application code.
* **backend** - This folder will contains the backend (BFF) application code.
* **infrastructure** - This folder will manage infrastructure provisioning scripts.
* **storybook** - This folder will contains Storybook integration.

**For more information**: [Microfrontend (MFE) and pipeline setups](../technicals/mfes-and-pipeline-setups/README.md)
* **storybook** - This folder will contains Storybook integration.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Front End Architecture
![](./img/architecture_diagrams-frontend.drawio.png)
![](../img/architecture_diagrams-frontend.drawio.png)

### Use of common libraries
One of the key concepts behind the new architecture is that the frontend contains a common UI library which is used across all the MFEs implemented inside the FSP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Organization of the source repository
![](./img/architecture_diagrams-code-structure.drawio-v2.png)
![](../img/architecture_diagrams-code-structure.drawio-v2.png)

We've established a clear separation of concerns within our codebase for better maintainability and scalability. This section outlines the structure for the client-side code and infrastructure, with placeholders for backend and storybook integration to be defined later.

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ metadata:
annotations:
github.com/project-slug: ${{ values.slug }}
backstage.io/adr-location: https://github.com/99x/product-central-architectures/tree/main/architectures/docs/decisions/aws-fullstack-app
backstage.io/techdocs-ref: url:https://github.com/99x/product-central-architectures/tree/main/architectures/docs/techdocs/aws-fullstack-app
description: ${{ values.name }} is a full-stack application which is built using AWS services.
tags:
- aws
Expand Down
1 change: 1 addition & 0 deletions architectures/github/aws-fullstack-app/template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ metadata:
description: Fullstack App deployed in AWS
annotations:
backstage.io/adr-location: https://github.com/99x/product-central-architectures/tree/main/architectures/docs/decisions/aws-fullstack-app
backstage.io/techdocs-ref: url:https://github.com/99x/product-central-architectures/tree/main/architectures/docs/techdocs/aws-fullstack-app
tags:
- aws
- full-stack
Expand Down

0 comments on commit ffecaec

Please sign in to comment.