Tipps für den Einstieg und Projektstruktur

Wenn Sie mit Node.js und npm-Projekten starten, ist es hilfreich, von Anfang an gute Gewohnheiten und eine sinnvolle Struktur zu verwenden. Das erleichtert die Arbeit – besonders, wenn Ihr Projekt wächst oder Sie mit anderen zusammenarbeiten.

Projektstruktur: Ein Beispiel

Ein einfaches Node.js-Projekt kann zum Beispiel so aufgebaut sein:

mein-projekt/
│
├── package.json
├── index.js
├── module/
│   └── rechner.js
├── data/
│   └── daten.json
└── node_modules/

Erläuterung:

• package.json: Ihre Projektbeschreibung und alle Abhängigkeiten
• index.js: Die Startdatei Ihrer Anwendung
• module/: Eigene JavaScript-Module, um den Code zu organisieren
• data/: Falls Sie z. B. JSON-Dateien oder eigene Daten einbinden möchten
• node_modules/: Hier landen automatisch Ihre installierten Pakete (diesen Ordner müssen Sie nie manuell verändern)

Hinweise zu ES Modules in Node.js

• Verwenden Sie in jeder Datei, die Sie selbst schreiben, import und export.
• Achten Sie auf die richtige Schreibweise der Pfade beim Import (z. B. import rechner from './module/rechner.js';)
• Setzen Sie "type": "module" in Ihrer package.json, damit Sie überall ES Modules nutzen können.

Weitere Tipps

• Dokumentieren Sie in einer Datei README.md, was Ihr Projekt macht, wie es gestartet wird und welche Pakete Sie nutzen.
• Lassen Sie Ihre Projekte übersichtlich wachsen – legen Sie neue Unterordner an, wenn Sie mehr Funktionen hinzufügen.
• Ignorieren Sie den Ordner node_modules in der Versionskontrolle (z.B. mit einer .gitignore), da dieser automatisch neu erstellt werden kann.
• Nutzen Sie die Hilfe von npm: Viele Pakete bieten nach Installation Beispielcode und Dokumentation im npm-Repository (https://www.npmjs.com/).

---

Aufgabe

Übung: Ihr erstes strukturiertes Projekt

1. Erstellen Sie einen neuen Ordner für Ihr Node.js-Projekt und initialisieren Sie dieses mit npm.
2. Legen Sie eine sinnvolle Struktur an, zum Beispiel mit getrennten Ordnern für eigene Module und Daten.
3. Legen Sie eine Startdatei (index.js) an und importieren Sie dort mindestens ein selbst geschriebenes Modul (z. B. import rechner from './module/rechner.js').
4. Schreiben Sie eine kurze README.md, in der Sie in zwei Sätzen Ihr Projekt und die Startanweisung beschreiben.

Probieren Sie aus, wie übersichtlich selbst kleine Projekte werden, wenn Sie diese konsequent strukturieren.