hochfrequenz / ahbesser-legacy Goto Github PK

https://github.com/Hochfrequenz/ahbesser/blob/e3ba22c1572e5eb108468b8198f6e434563c985b/.github/workflows/build.yml#L19

the backend should be easy to start.

This issue contains just the ideas about the architecture discussion between @ohenning, @TommyBom and me.

Goals

• easy to maintain service
• backend and frontend should be in one repository
• the application should run in a container
• the backend will deliver the AHB json files for the frontend

Frameworks / Approaches

• we want to use tailwind css
• we use express server as backend (so we only use one language typescript)
• we will write an openapi.yml and derive code for backend and frontend from

Future Improvements

In the first approach we will add all AHB json files into the Dockerfile itself.
So to update the AHBs we need to deploy the service every time.

In the future we could use a blob storage (like a S3 bucket) to load the json files.
This would make it easier to update them.
Another idea would be to load them directly from the repo http://github.com/Hochfrequenz/machine-readable_anwendungshandbuecher/.

goal is to easily start the frontend with the new setup.

fabsenet/edi-energy-viewer#1 (comment)

The openapi.yaml describes the API.
It will get used to derive some code for the client and server side.