Entwickler-Bereich

Entwicklung & Beitragen

TruckPilot ist Open Source. Erfahre wie du das Projekt lokal einrichtest und beitragen kannst.

Tech Stack

Python

Backend & Bildverarbeitung

FastAPI

REST-API & WebSocket

Next.js

Frontend & Dashboard

Electron

Desktop-App

Lokale Entwicklung

1. Repository klonen

git clone https://github.com/LSSippler/TruckPilot.git
cd TruckPilot

2. Backend einrichten

# Python Virtual Environment
cd backend
python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt
python -m uvicorn src.main:app --reload

3. Frontend einrichten

cd frontend
npm install
npm run dev

4. Electron-App (optional)

cd electron
npm install
npm start

Projektstruktur

TruckPilot/
├── backend/           # Python FastAPI Backend
│   ├── src/
│   │   ├── main.py        # API-Einstiegspunkt
│   │   ├── telemetry/     # SCS SDK Integration
│   │   ├── autopilot/     # Autopilot-Logik
│   │   ├── lane_detection/# OpenCV Spurerkennung
│   │   └── map_parser/    # SCS-Archiv Parser
│   └── requirements.txt
├── frontend/          # Next.js Web-Dashboard
│   ├── src/
│   │   ├── app/           # App Router
│   │   ├── components/    # React-Komponenten
│   │   └── hooks/         # Custom Hooks
│   └── messages/          # i18n Übersetzungen
├── electron/          # Desktop-App Wrapper
│   └── src/
└── docs/              # Zusätzliche Dokumentation

Beitragen

Wir freuen uns über jeden Beitrag! Hier sind einige Möglichkeiten:

  • Bug Reports: Melde Fehler über GitHub Issues
  • Feature Requests: Schlage neue Funktionen vor
  • Pull Requests: Reiche Code-Änderungen ein
  • Übersetzungen: Hilf bei der Lokalisierung
  • Dokumentation: Verbessere die Docs

Lies die CONTRIBUTING.md für detaillierte Richtlinien.