Developer Guidelines Struktur des Repositories

Struktur des Repositories

Das Repository ist wie folgt aufgebaut:

1. Generelle Konfigurationsdateien wie package.json oder tsconfig.json liegen im Root des Repos.

2. In public befinden sich unter anderem die vordefinierten Daten wie Trips, Fahrzeuge oder Benutzer.

   public
   └── data
       ├── risk
       ├── trips.json
       ...
       └── vehicles.json
   

3. Unter src befinden sich alle Quelldateien der Anwendung. Diese sind in folgende Ordner aufgeteilt: Hier sind besonders backend sowie components und views interessant. Alle Ornder die nicht unter backend liegen, sind Frontend-bezogen. components enthält alle wiederverwendbaren Vue-Komponenten, die in den Views eingesetzt werden. views enthält die einzelnen Views wie z.B. DefaultView.vue, die vom Vue-Router angesteuert werden können.

   In locales werden die Übersetzungen in JSON-Dateien gespeichert.

    src
    ├── animation
    ├── backend
    │   ├── __tests__
    │   ├── dataFields
    │   ├── dataModules
    │   ├── riskManager
    │   ├── utils
    │   ├── DataLoader.ts
    │   ├── DataManager.ts
    │   ...
    │   └── TripAnimator.ts
    ├── components
    │   ├── MainComponent.vue
    │   ...
    │   └── MapComponent.vue
    ├── locales
    ├── router
    ├── utils
    ├── views
    │   ├── dataViewer
    │   │   ├── DefaultView.vue
    │   │   ├── VehicleDataView.vue
    │   │   ...
    │   │   └── WelcomeView.vue
    │   └── DataView.vue
    ├── App.vue
    ├── i18n.ts
    ...
    └── main.ts