Skip to content

DEVELOPER.md

Latest commit

 

History

History
85 lines (57 loc) · 1.6 KB

DEVELOPER.md

File metadata and controls

85 lines (57 loc) · 1.6 KB
Raw

Developer Dokumentation

💻 Installation & Entwicklung

Option 1: Mit Docker

Die einfachste Methode, das Projekt lokal zu starten:

# Repository klonen
git clone https://github.com/th-koeln/mi-bachelor-abschlussarbeiten.git
cd mi-bachelor-abschlussarbeiten

# Container starten
docker-compose up

# Website öffnen über [http://localhost:4000](http://localhost:4000)

Voraussetzungen: Docker und Docker Compose

Option 2: Lokale Installation

Voraussetzungen:

  • Ruby >= 2.7 (für Jekyll)
  • Node.js >= 18.x und npm (für Tailwind CSS)
  • Bundler (gem install bundler)

Installation:

  1. Repository klonen

    git clone https://github.com/th-koeln/mi-bachelor-abschlussarbeiten.git
cd mi-bachelor-abschlussarbeiten

  2. Ruby-Abhängigkeiten installieren

    bundle install

  3. Node.js-Abhängigkeiten installieren

    npm install

  4. Development-Server starten

    npm run dev

    Dies startet parallel:

    • Jekyll mit LiveReload auf http://localhost:4000
    • Tailwind CSS im Watch-Modus

    Alternativ können Sie die Prozesse auch separat starten:

    # Terminal 1: Tailwind CSS Watch
npm run css:dev

# Terminal 2: Jekyll Server
npm run jekyll:serve

Production Build

# CSS kompilieren und Jekyll-Website bauen
npm run build

# Ausgabe liegt in _site/

🌐 API-Endpunkte

Die Plattform stellt folgende API-Endpunkte bereit:

  • /bachelor.json - Alle Bachelorarbeiten
  • /master.json - Alle Masterarbeiten
  • /index.json - Alle Arbeiten kombiniert