Add README.md

This commit is contained in:
Juhn-Vitus Saß
2025-01-17 18:13:48 +00:00
parent 7cbd2fe8dd
commit c9de0668e4

58
README.md Normal file
View File

@@ -0,0 +1,58 @@
# qivip-Projektanleitung
## Inhaltsverzeichnis
1. [Initialisierung des Projekts](#initialisierung-des-projekts)
2. [Starten des Servers](#starten-des-servers)
## Initialisierung des Projekts
Um das Projekt erfolgreich zu starten, folge diesen Schritten:
1. Einen SSH-Key erstellen und den öffentlichen Schlüssel bei **Edugit** hinterlegen.
2. Das Repository klonen:
```sh
git clone <repository-url>
```
3. In den `qivip`-Ordner wechseln:
```sh
cd qivip
```
4. Eine virtuelle Umgebung namens `.venv` erstellen:
```sh
python3 -m venv .venv
```
5. Die virtuelle Umgebung aktivieren:
- **Unter Linux:**
```sh
source .venv/bin/activate
```
- **Unter Windows (cmd):**
```sh
.venv\Scripts\activate
```
6. Die benötigten Abhängigkeiten installieren:
```sh
pip install -r requirements.txt
```
7. Die Datenbank migrieren:
```sh
python3 core/manage.py migrate
```
## Starten des Servers
### Entwicklungsserver starten
Um den Server zu starten, verwende einen der folgenden Befehle:
- Standardport (8000):
```sh
python3 core/manage.py runserver
```
- Bestimmten Port (z. B. 9000):
```sh
python3 core/manage.py runserver 9000
```
Damit ist das Projekt erfolgreich eingerichtet und der Server kann gestartet werden!