Compare commits

...

17 Commits

8 changed files with 45 additions and 50 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

3
.gitignore vendored
View File

@@ -3,4 +3,5 @@ backend/node_modules
frontend/node_modules
.idea
.DS_Store
**/go_init
**/go_init
generator

View File

@@ -1,51 +1,58 @@
Projektname
# Projektname
Projektübersicht
## Projektübersicht
Geben Sie hier eine kurze Beschreibung des Projekts ein. Was ist das Ziel des Projekts? Welche Problemstellung löst es?
Verwendete Technologien
## Verwendete Technologien
Backend: Node.js, TypeScript, Express oder Fastify
Frontend: React (nur bei mittleren Projekten)
Containerisierung: Docker, Docker Compose
Projektstruktur
* **Backend:** Node.js, TypeScript, Express oder Fastify
* **Frontend:** React (nur bei mittleren Projekten)
* **Containerisierung:** Docker, Docker Compose
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
## Projektstruktur
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.
* **backend/:** Enthält den Backend-Code (z.B. Express, Fastify)
* **frontend/:** Enthält den Frontend-Code (nur bei mittleren Projekten)
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
## Einrichtung und Konfiguration
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
1. **Repository klonen**
```bash
git clone <repository-url>
cd <repository-verzeichnis>
```
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.
```bash
docker-compose up --build
```
## 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
* **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.
Visual Studio Code spezifische Konfigurationen sind im .vscode-Verzeichnis enthalten:
##Anmerkung
tasks.json: Enthält vordefinierte Tasks für das Projekt.
launch.json: Konfiguriert Debugging-Optionen für Backend und Frontend.
Das Go Repo befindet sich abweichend zu diesem nicht auf dem Lokalen Server sondern bei GitHub
## Autor
Christian Schindler

Submodule go_init deleted from 48a4f82f42

BIN
linux

Binary file not shown.

BIN
macos

Binary file not shown.

View File

@@ -1,12 +0,0 @@
{
"name": "templateprojekt",
"version": "1.0.0",
"description": "",
"keywords": [],
"author": "Christian Schindler",
"license": "ISC",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
}
}

BIN
windows.exe Executable file → Normal file

Binary file not shown.