52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
Projektname
|
|
|
|
Projektübersicht
|
|
|
|
Geben Sie hier eine kurze Beschreibung des Projekts ein. Was ist das Ziel des Projekts? Welche Problemstellung löst es?
|
|
|
|
Verwendete Technologien
|
|
|
|
Backend: Node.js, TypeScript, Express oder Fastify
|
|
Frontend: React (nur bei mittleren Projekten)
|
|
Containerisierung: Docker, Docker Compose
|
|
Projektstruktur
|
|
|
|
backend/: Enthält den Backend-Code (z.B. Express, Fastify)
|
|
frontend/: Enthält den Frontend-Code (nur bei mittleren Projekten)
|
|
.vscode/: Visual Studio Code spezifische Konfigurationen
|
|
utils/: Hilfsfunktionen und Skripte
|
|
Einrichtung und Konfiguration
|
|
|
|
Schritt 1: Repository klonen
|
|
sh
|
|
Code kopieren
|
|
git clone <repository-url>
|
|
cd <repository-verzeichnis>
|
|
Schritt 2: Docker Container starten
|
|
Die Anwendung wird vollständig mit Docker konfiguriert und gestartet. Stellen Sie sicher, dass Docker auf Ihrem System installiert und gestartet ist.
|
|
|
|
sh
|
|
Code kopieren
|
|
docker-compose up --build
|
|
Schritt 3: Umgebungsvariablen
|
|
Stellen Sie sicher, dass alle notwendigen Umgebungsvariablen in einer .env-Datei im Wurzelverzeichnis des Projekts definiert sind.
|
|
|
|
Projektbeschreibung
|
|
|
|
Ziel des Projekts: Beschreiben Sie hier, welches Ziel das Projekt verfolgt und welche Problemstellungen es lösen soll.
|
|
Hauptfunktionalitäten: Listen Sie die wichtigsten Funktionen des Projekts auf.
|
|
Bekannte Probleme: Dokumentieren Sie bekannte Bugs oder Einschränkungen.
|
|
Zukünftige Verbesserungen: Welche Features sollen in zukünftigen Versionen hinzugefügt werden?
|
|
Docker-Konfiguration
|
|
|
|
Die Docker-Konfigurationsdateien sind im Repository enthalten und bereits für die Entwicklung und den Einsatz vorbereitet.
|
|
|
|
Dockerfile: Definiert das Docker-Image für das Projekt.
|
|
docker-compose.yml: Konfiguriert und startet mehrere Docker-Container, einschließlich Backend und (falls vorhanden) Frontend.
|
|
VSCode Konfiguration
|
|
|
|
Visual Studio Code spezifische Konfigurationen sind im .vscode-Verzeichnis enthalten:
|
|
|
|
tasks.json: Enthält vordefinierte Tasks für das Projekt.
|
|
launch.json: Konfiguriert Debugging-Optionen für Backend und Frontend.
|