feat: updated docs to include filestruct
This commit is contained in:
26
Readme.md
26
Readme.md
@@ -120,3 +120,29 @@ Antwort `202` Akzeptiert und eingefügt
|
||||
|
||||
Antwort `409` Konflikt
|
||||
Die vorherige Buchung am selben Tag hat den gleichen Buchungstyp
|
||||
|
||||
# Filestrukture
|
||||
|
||||
```
|
||||
├── Backend (Webserver)
|
||||
│ ├── doc (Templates for Document Creator --> typst used to create PDF Reports)
|
||||
│ │ ├── static
|
||||
│ │ └── templates
|
||||
│ ├── endpoints (HTML Server endpoints (see main.go for Routes))
|
||||
│ ├── helper (Helper classes)
|
||||
│ │ ├── logs
|
||||
│ │ └── paramParser
|
||||
│ ├── logs (Log Folder, no sourcecode)
|
||||
│ ├── migrations (DB Migrations Folder, no direct sourcecode)
|
||||
│ ├── models (DB Models and their function)
|
||||
│ ├── src (Tailwind src --> used to config css formatter)
|
||||
│ ├── static (Webserver static, used to server static content, e.g. JS and CSS files)
|
||||
│ │ └── css
|
||||
│ └── templates (HTML Templates for every page written in templ and compiled to go)
|
||||
├── Cron (all Cron Scripts)
|
||||
├── DB (local Database mount Point)
|
||||
│ └── initdb (initialization scripts for DB)
|
||||
├── Docker (Docker Files, only docker-compose.yaml used)
|
||||
├── docs
|
||||
└── └── images
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user