Files
gocarlog/docs/project-structure.md
T

3.0 KiB

GoCarLog - Projektstruktur

Verzeichnisstruktur

gocarlog/
├── cmd/
│   └── server/
│       └── main.go              # Entry point: DB init, Router starten, Server starten
├── internal/
│   ├── db/
│   │   ├── database.go          # SQLite-Verbindung, Migrationen, Seed-Daten (Kraftstoffe)
│   │   └── migration.sql        # SQL-Statements für Tabellen-Erstellung
│   ├── model/
│   │   ├── fuel.go              # Struktur + Methoden für Kraftstoff
│   │   ├── vehicle.go           # Struktur + Methoden für Fahrzeug
│   │   └── log.go               # Struktur + Methoden für Logbucheintrag
│   ├── handler/
│   │   ├── vehicle.go           # HTTP-Handler: POST /api/vehicles, GET /api/vehicles, GET /api/vehicles/:id
│   │   ├── log.go               # HTTP-Handler: POST /api/logs, GET /api/logs
│   │   ├── consumption.go       # HTTP-Handler: GET /api/vehicles/:id/consumption
│   │   └── static.go            # Statische Dateien ausliefern (frontend/)
│   ├── router/
│   │   └── router.go            # Router-Setup mit gorilla/mux oder net/http
│   └── middleware/
│       └── middleware.go        # CORS, Logging, Error-Handling
├── frontend/
│   ├── index.html               # Hauptseite mit SPA-Routing
│   ├── css/
│   │   └── style.css            # Dunkles, modernes Design
│   ├── js/
│   │   ├── app.js               # SPA-Routing, View-Management
│   │   ├── api.js               # API-Client (fetch-Wrapper)
│   │   └── views/
│   │       ├── logs.js          # Logbuch-Ansicht
│   │       ├── vehicles.js      # Fahrzeugliste
│   │       ├── vehicle-detail.js # Fahrzeugdetails
│   │       └── forms.js         # Eingabemasken (Fahrzeug anlegen, Log eintragen)
│   └── assets/
│       └── (Icons, Bilder)
├── docs/
│   ├── project-structure.md     # Diese Datei
│   ├── database-schema.md       # Datenbank-Struktur (Milestone 3)
│   └── api-spec.md              # JSON-Schnittstelle (Milestone 4)
├── tests/                       # Integrationstests
│   └── api_test.go
├── go.mod                       # Go Module Definition
└── README.md

Package-Erklärung

  • cmd/server: Der einzige Entry Point. Initialisiert DB, lädt Router, startet HTTP-Server.
  • internal/db: Datenbankverbindung, Schema-Migrationen, Initialdaten.
  • internal/model: Datenstrukturen (Go structs) und domain-spezifische Methoden.
  • internal/handler: HTTP-Handler-Funktionen (Request → Response).
  • internal/router: URL-Routing-Definitionen.
  • internal/middleware: Cross-cutting concerns (CORS, Logging, Error-Handling).
  • frontend/: Statische Webdateien (HTML/CSS/JS), vom Backend ausgeliefert.
  • docs/: Projektdokumentation.
  • tests/: Testdateien.