Compare commits
17 Commits
e01b7fe50b
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 8ebc6fef49 | |||
| 946b3092f9 | |||
| 2c1216c00b | |||
| db807b32cd | |||
| 247c8264a4 | |||
| 5b487a91fa | |||
| dde1f9e868 | |||
| 29089fa268 | |||
| 9d067294fb | |||
| 1df37ee5c3 | |||
| 566bc5f07b | |||
| 79ddafea9d | |||
| 40bc7de1cc | |||
| 17e0888215 | |||
| 608c9091f8 | |||
| 3204301a0b | |||
| 65cabc1012 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -3,4 +3,5 @@ backend/node_modules
|
|||||||
frontend/node_modules
|
frontend/node_modules
|
||||||
.idea
|
.idea
|
||||||
.DS_Store
|
.DS_Store
|
||||||
**/go_init
|
**/go_init
|
||||||
|
generator
|
||||||
79
README.md
79
README.md
@@ -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?
|
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
|
* **Backend:** Node.js, TypeScript, Express oder Fastify
|
||||||
Frontend: React (nur bei mittleren Projekten)
|
* **Frontend:** React (nur bei mittleren Projekten)
|
||||||
Containerisierung: Docker, Docker Compose
|
* **Containerisierung:** Docker, Docker Compose
|
||||||
Projektstruktur
|
|
||||||
|
|
||||||
backend/: Enthält den Backend-Code (z.B. Express, Fastify)
|
## Projektstruktur
|
||||||
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
|
* **backend/:** Enthält den Backend-Code (z.B. Express, Fastify)
|
||||||
sh
|
* **frontend/:** Enthält den Frontend-Code (nur bei mittleren Projekten)
|
||||||
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
|
## Einrichtung und Konfiguration
|
||||||
|
|
||||||
Ziel des Projekts: Beschreiben Sie hier, welches Ziel das Projekt verfolgt und welche Problemstellungen es lösen soll.
|
1. **Repository klonen**
|
||||||
Hauptfunktionalitäten: Listen Sie die wichtigsten Funktionen des Projekts auf.
|
|
||||||
Bekannte Probleme: Dokumentieren Sie bekannte Bugs oder Einschränkungen.
|
```bash
|
||||||
Zukünftige Verbesserungen: Welche Features sollen in zukünftigen Versionen hinzugefügt werden?
|
git clone <repository-url>
|
||||||
Docker-Konfiguration
|
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.
|
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.
|
* **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.
|
* **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:
|
##Anmerkung
|
||||||
|
|
||||||
tasks.json: Enthält vordefinierte Tasks für das Projekt.
|
Das Go Repo befindet sich abweichend zu diesem nicht auf dem Lokalen Server sondern bei GitHub
|
||||||
launch.json: Konfiguriert Debugging-Optionen für Backend und Frontend.
|
|
||||||
|
|
||||||
|
## Autor
|
||||||
|
|
||||||
|
Christian Schindler
|
||||||
|
|||||||
1
go_init
1
go_init
Submodule go_init deleted from 48a4f82f42
12
package.json
12
package.json
@@ -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
BIN
windows.exe
Executable file → Normal file
Binary file not shown.
Reference in New Issue
Block a user