Home

Dokumentation für das Projekt "ai-dev-process-sample"

Dieses Projekt stellt eine einfache API bereit, die zufällige Programmierer-Witze zurückgibt. Es basiert auf Node.js und dem Express Framework.

---

Voraussetzungen

• Node.js (Version 18 oder höher empfohlen)
• npm (Node Package Manager)

---

Installation

1. Projekt herunterladen oder klonen

   git clone https://github.com/GregorBiswanger/ai-dev-process-sample.git
   cd ai-dev-process-sample

2. Abhängigkeiten installieren

   Führe im Projektverzeichnis folgenden Befehl aus, um alle benötigten Pakete (insbesondere Express) zu installieren:

   npm install

---

Nutzung

Server starten

Im Projektverzeichnis kann der Server mit folgendem Befehl gestartet werden:

npm start

• Alternativ direkt mit Node:

  node server.js

• Der Server läuft standardmäßig auf Port 3000, sofern keine Umgebungsvariable PORT gesetzt ist.

Zugriff auf die API

• Die API stellt einen Endpunkt zur Verfügung:

  GET http://localhost:3000/api/jokes
  

• Dieser Endpunkt gibt einen zufälligen Programmierer-Witz als JSON zurück, zum Beispiel:

  {
    "id": 5,
    "setup": "Why was the JavaScript developer sad?",
    "punchline": "Because he didn't Node how to Express himself."
  }

Beispiel mit curl

curl http://localhost:3000/api/jokes

---

Projektstruktur

• server.js
  Stellt den Express-Server mit einer Route /api/jokes bereit, der zufällige Witze liefert.
• package.json
  Enthält Metadaten, Abhängigkeiten (Express v5), und Skripte für npm.
• package-lock.json
  Lockfile für installierte npm-Pakete, gewährleistet reproduzierbare Builds.
• .gitignore
  Definition, welche Dateien und Ordner nicht ins Git-Repository aufgenommen werden sollen (z.B. node_modules/).

---

Weiterentwicklung

• Tests sind aktuell nicht implementiert (siehe package.json: "test"-Skript ist ein Platzhalter).
• Es kann eine Erweiterung z.B. um mehr API-Endpunkte, Datenbankanbindung oder Frontend-Anbindung erfolgen.

---

Fehlerbehebung & Beiträge

• Fehler und Probleme können auf der GitHub Issues-Seite gemeldet werden:
  https://github.com/GregorBiswanger/ai-dev-process-sample/issues
• Das Repository kann zum eigenen Fork verarbeitet und Pull-Requests zur Verbesserung eingereicht werden.

---

Lizenz

Das Projekt steht unter der Lizenz ISC (Internet Systems Consortium License).

---

Zusammenfassung

Dieses Projekt ermöglicht es dir, schnell und einfach einen kleinen Webserver mit Express aufzusetzen, der beim Zugriff auf /api/jokes einen zufälligen Witz zurückgibt. Ideal für Lernzwecke rund um Node.js, Express und simple API-Entwicklung.