Stefan Franke

Entwicklung interaktiver Softwareanwendungen

Forgejo – Projektplattform der PH Weingarten

Forgejo ist eine Open-Source-Plattform zur Verwaltung von Projekten und Dateien – ähnlich wie GitHub, aber selbst gehostet auf unserem eigenen Server. Alle Daten bleiben an der PH Weingarten.

Forgejo kann weit mehr als nur Code verwalten. Es eignet sich für alle Arten von Projekten: Seminararbeiten, Forschungsdaten, Dokumentationen, Webseiten oder Softwareprojekte.

Was kann Forgejo?

Übungsaufgaben

Aufgabe 1: Account erstellen & einrichten

1. Öffnet git.md-phw.de im Browser und klickt auf Registrieren.
2. Registriert euch mit eurer PH-Mailadresse (z. B. name@stud.ph-weingarten.de oder name@ph-weingarten.de).
3. Wählt einen Benutzernamen und ein sicheres Passwort.
4. Vervollständigt euer Profil: Einstellungen → Profil
   • Vollständiger Name
   • Kurze Biografie (optional)
   • Profilbild / Avatar (optional)

Aufgabe 2: Erstes Repository erstellen

1. Klickt auf das +-Symbol oben rechts und wählt Neues Repository.
2. Vergebt einen aussagekräftigen Namen, z. B. mein-erstes-projekt.
3. Fügt eine Beschreibung hinzu (1–2 Sätze, was das Projekt enthält).
4. Setzt das Häkchen bei „Repository mit README initialisieren“.
5. Wählt bei .gitignore eine passende Vorlage (z. B. VisualStudio, Python oder None).
6. Wählt eine Lizenz (z. B. MIT für offene Projekte oder None für private).
7. Klickt auf Repository erstellen.

Aufgabe 3: README mit Markdown gestalten

Die Datei README.md ist die Visitenkarte eures Projekts. Sie wird automatisch auf der Startseite des Repositorys angezeigt.

1. Klickt auf README.md und dann auf den Bearbeiten-Stift (oben rechts in der Dateiansicht).
2. Gestaltet die Datei mit Markdown:

# Projektname

Kurze Beschreibung des Projekts in 1-2 Sätzen.

## Inhalt

- Beschreibung der enthaltenen Dateien
- Verwendungszweck

## Mitwirkende

| Name | Rolle |
|------|-------|
| Max Muster | Projektleitung |
| Anna Beispiel | Dokumentation |

## Lizenz

Dieses Projekt steht unter der MIT-Lizenz.

3. Nutzt die Vorschau-Funktion (Reiter neben „Bearbeiten“), um das Ergebnis zu prüfen.
4. Klickt auf Änderungen committen und gebt eine kurze Beschreibung ein (z. B. „README mit Projektbeschreibung ergänzt“).

Aufgabe 4: Dateien hochladen

Forgejo unterstützt den Upload beliebiger Dateien direkt im Browser – ganz ohne Terminal.

1. Klickt in eurem Repository auf Datei hinzufügen → Datei hochladen.
2. Zieht Dateien per Drag & Drop in das Upload-Feld oder wählt sie über den Dialog aus. Beispiele:
   • Ein PDF-Dokument (z. B. eine Projektbeschreibung)
   • Ein Bild (z. B. ein Diagramm oder Foto)
   • Eine Textdatei oder Tabelle
3. Gebt eine Commit-Nachricht ein (z. B. „Projektdokumentation als PDF hochgeladen“) und klickt auf Änderungen committen.
4. Prüft, ob die Dateien in der Repository-Übersicht sichtbar sind.

Aufgabe 5: Wiki nutzen

Jedes Repository hat ein eigenes Wiki für Dokumentation, Anleitungen oder Protokolle.

1. Navigiert in eurem Repository zu Wiki (obere Navigationsleiste).
2. Klickt auf Erste Seite anlegen (oder Neue Seite).
3. Erstellt eine Startseite mit Markdown, z. B.:

# Willkommen

Dies ist die Dokumentation für unser Projekt.

## Inhaltsverzeichnis

- [Einrichtung](Einrichtung)
- [Nutzung](Nutzung)
- [FAQ](FAQ)

## Schnellstart

1. Repository klonen
2. Dateien bearbeiten
3. Änderungen pushen

4. Speichert die Seite.
5. Erstellt mindestens eine weitere Wiki-Seite (z. B. „Einrichtung“) und verlinkt sie von der Startseite aus.

Aufgabe 6: Issues & Kanban-Board

Issues sind Aufgaben, Ideen oder Fehlerberichte. Mit dem Kanban-Board behaltet ihr den Überblick über den Projektfortschritt.

Issues erstellen

1. Navigiert zu Issues → Neuer Issue.
2. Erstellt drei Beispiel-Issues für euer Projekt, z. B.:
   • „README vervollständigen“
   • „Projektbericht als PDF hochladen“
   • „Lizenz auswählen und hinzufügen“
3. Vergebt Labels (z. B. „Dokumentation“, „Aufgabe“) – erstellt eigene Labels unter Labels → Neues Label.
4. Weist einen Issue eurem Tandempartner zu (Zuständig).

Kanban-Board einrichten

5. Navigiert zu Projekte → Neues Projekt.
6. Erstellt ein Projekt (z. B. „Website-Projekt“) mit der Vorlage Einfaches Kanban.
7. Das Board hat drei Spalten: To Do, In Progress, Done.
8. Fügt eure Issues zum Board hinzu und verschiebt sie per Drag & Drop zwischen den Spalten.

Aufgabe 7: Mitarbeiter einladen

Arbeitet gemeinsam an einem Repository – ladet eine Kollegin, einen Kollegen oder euren Tandempartner ein.

1. Navigiert zu Einstellungen → Mitarbeiter in eurem Repository.
2. Gebt den Benutzernamen der Person ein und klickt auf Mitarbeiter hinzufügen.
3. Wählt die passende Berechtigung:
   • Lesen – Kann Dateien ansehen, aber nicht ändern
   • Schreiben – Kann Dateien ändern und Issues bearbeiten
   • Admin – Volle Kontrolle über das Repository
4. Bittet euren Mitarbeiter, eine Änderung vorzunehmen (z. B. eine Datei hochzuladen oder ein Issue zu kommentieren).

Aufgabe 8: Dateien im Browser bearbeiten

Einfache Textdateien, Markdown und sogar HTML/CSS können direkt in Forgejo bearbeitet werden.

1. Klickt auf eine Datei in eurem Repository (z. B. README.md).
2. Klickt auf den Bearbeiten-Stift.
3. Nehmt eine Änderung vor.
4. Nutzt die Vorschau, um das Ergebnis zu prüfen.
5. Gebt eine Commit-Nachricht ein und bestätigt.

Aufgabe 9: Organisation erstellen

Organisationen gruppieren mehrere Repositories und Personen – ideal für Kurse, Forschungsgruppen oder Abteilungen.

1. Klickt auf das +-Symbol oben rechts und wählt Neue Organisation.
2. Vergebt einen Namen (z. B. eis-sose26 für euren Kurs oder den Namen eurer Arbeitsgruppe).
3. Fügt eine Beschreibung hinzu.
4. Erstellt ein Team innerhalb der Organisation:
   • Navigiert zu Organisation → Teams → Neues Team
   • Z. B. „Studierende“ (Schreibzugriff) oder „Betreuer“ (Admin)
5. Ladet Mitglieder in das Team ein.
6. Erstellt ein Repository innerhalb der Organisation (nicht unter eurem persönlichen Account).

Forgejo & projects.md-phw.de

Projekte, die auf git.md-phw.de verwaltet werden, können auf projects.md-phw.de der Öffentlichkeit präsentiert werden. So werden Studierendenprojekte und Forschungsarbeiten nach außen sichtbar.

Damit ein Projekt auf der Showcase-Plattform erscheint, reicht es, ein öffentliches Repository mit einem aussagekräftigen README.md und optional einem Coverbild (cover.png oder cover.webp) im Repository abzulegen.

Kurzreferenz: Forgejo-Funktionen

Zurück zu U5: Git-Grundlagen