Handbuch

Der Nusszopf ist eine Community-Plattform, auf der Menschen Projekte einstellen und dazuschreiben, was ihnen noch fehlt: Mitstreiter:innen, Räume, Materialien, Geld oder etwas anderes. Dieses Handbuch beschreibt die Software so, wie sie heute ist. Es ist für Menschen geschrieben, die den Quellcode nie gesehen haben.

Womit möchtest Du anfangen?

Ich will einen Nusszopf betreiben. Du brauchst einen Server mit Docker und eine Domain, sonst nichts.

Installation: vom leeren Verzeichnis zur laufenden Instanz.
Konfiguration: Mailversand, Rechtstexte und alle Einstellungen der .env.
Deployment: eine neue Version einspielen und, wenn nötig, zurückgehen.
Betrieb, Backup und Wiederherstellung und Fehlerbehebung für den Alltag.

Ich will mitentwickeln. Du brauchst Docker, Docker Compose und Git, keine PHP- oder Node-Installation.

Lokale Entwicklung: der erste Start und die Befehle, die Du täglich brauchst.
Architektur und Geschäftslogik: wie die Teile zusammenhängen und welche Regeln gelten.
Tests und Qualität und Konventionen: was vor einem Pull Request laufen muss und warum vieles so ist, wie es ist.

Ich will nur verstehen, was das ist. Lies den Überblick und probiere die Demo auf nusszopf.org aus. Sie ist der echte Nusszopf mit erfundenen Beispielprojekten.

Wie dieses Handbuch aufgebaut ist

Jede Seite erklärt zuerst in Worten, was passiert und warum, und zeigt dann den Befehl. Befehle sind beschriftet:

Auf dem Server

# Diese Befehle laufen auf dem Server, im Verzeichnis Deiner Installation.
docker compose ps

Lokale Entwicklung

# Diese Befehle laufen auf Deinem Rechner, im Repository, für die lokale Entwicklung.
docker compose -f compose.dev.yaml ps

Hinweiskästen wie dieser sind sparsam gesetzt: Tipp für Abkürzungen, Achtung für Dinge, die Daten kosten können.

Was dieses Handbuch nicht ist

Der Nusszopf ist die Neuimplementierung einer älteren Anwendung. Wie das historische Produkt aussah, warum eine Entscheidung so fiel und welche Mängel des Originals behoben wurden, steht in der englischsprachigen Spezifikation unter docs/. Das Handbuch verweist dorthin, wo es hilft, wiederholt sie aber nicht. Wo was steht, erklärt Dokumentation pflegen.