In vier Schritten zu Ihrem ersten Tool

Sie holen Modulstack mit einem Befehl von Forgejo und haben die Basis direkt in Ihrem Projekt. Dann fangen Sie an und ergänzen Ihre eigenen Funktionen. Alles andere ist schon da.

Zum Repository auf Forgejo →

Code, Anleitung und Releases an einem Ort. Das Repository ist öffentlich und steht unter der AGPL 3.0.

Voraussetzungen

Wenig. Die Basis bringt alles mit, was Sie sonst selbst aufbauen müssten.

Git

Mit einem Befehl klonen Sie das Repository in Ihr Projekt.

Node.js und Python

Node.js mit npm baut die Oberfläche (SvelteKit). Python mit venv führt das Backend (Django) aus. Aktuelle Versionen genügen, Rust brauchen Sie zum Start nicht.

Linux oder macOS

Zum Testen reicht Ihr eigener Rechner. Das Startskript nutzt lsof und curl. Docker brauchen Sie nicht.

Empfohlen ist ein grundlegendes Verständnis von Softwarearchitektur und Softwaretools.

Vom Download zum laufenden Tool

1 Repository klonen

Ein Befehl holt Modulstack von Forgejo. Danach liegt die Basis direkt in Ihrem Projekt.

git clone https://forgejo.bit-tag.com/websuite-io/modulstack.git
cd modulstack

2 Projekt starten

Installieren Sie einmal die Abhängigkeiten. Danach startet ein Skript Django und die Oberfläche zusammen, Docker ist dafür nicht nötig. Die App läuft dann unter http://localhost:5173. Beim Start richtet das Skript die Datenbank selbst ein (SQLite, im Datenordner). Die Installation der Abhängigkeiten dauert etwa eine Minute.

npm install
python3 -m venv .venv
.venv/bin/pip install -r core/backend/requirements.txt -r core/backend/requirements-dev.txt
./dev.sh

3 Anmelden und Basis einrichten

Legen Sie Ihr erstes Konto an und melden Sie sich an. Anmeldung, Gruppen und Rechte sind bereits fertig. In einem zweiten Terminal ausführen, im Projektordner. Danach unter http://localhost:5173 mit diesem Konto anmelden.

.venv/bin/python core/backend/manage.py createsuperuser

4 Eigene Module bauen

Legen Sie ein Modul an, zum Beispiel ein CRM, und bauen Sie Ihre Funktionen. Anmeldung, Rechte und Design bringt die Basis mit. Das Gerüst, die Tabellen und die Tests legt der Befehl für Sie an.

npm run neu -- modul mein_modul --label "Mein Modul" --produkt starter
touch modules/__init__.py
.venv/bin/python core/backend/manage.py makemigrations mein_modul
.venv/bin/python core/backend/manage.py migrate
.venv/bin/pytest -q modules/mein_modul

--produkt starter trägt das Modul in products/starter/product.json ein. Ohne das findet Django das Modul nicht. Danach ./dev.sh neu starten (Strg+C, dann ./dev.sh), dann erscheint das Modul in der App. Name, Farben und Module Ihrer App stehen in products/starter/product.json.

Drei Wege, Ihr Tool zu füllen

Eigenes Modul bauen

Bauen Sie Ihre Funktion als Modul, zum Beispiel ein CRM, direkt auf der Basis.

Eigene Funktion ergänzen

Ergänzen Sie weitere Funktionen. Design, Anmeldung und Rechte kommen von der Basis.

Externes Tool anbinden

Verbinden Sie ein vorhandenes Tool samt Datenbank per Erweiterung. Die Anbindung läuft über die Basis.

So bleibt Ihr Tool aktuell

Sicherheit liegt bei Ihnen

Für Ihren eigenen Code sind Sie verantwortlich. Die Basis liefert ein Fundament auf Django und SvelteKit, ersetzt aber keine Prüfung Ihrer Erweiterungen.

Updates einspielen

Jede Version des Core kommt als ein Commit mit Tag ins Repository. Ihr eigener Code liegt nur in modules/<name>/ und products/<name>/, der Core nur in core/. Ein Update holen Sie mit git fetch --tags und git merge <Tag>, danach npm install, pip install und Ihre Tests. Sicherheitsupdates ändern nur den Core. Ändern Sie nichts in core/, dann bleibt jedes Update möglich.

Sicherung und Betrieb

Die App bringt eine eingebaute Sicherung mit, die alle Daten exportiert. Ihre Daten liegen im Datenordner (standardmäßig core/data/, einstellbar mit MODULSTACK_DATA_DIR). Eine Sicherung spielen Sie mit dem Befehl import_backup wieder ein.

Auf einem Server

Für den Betrieb gibt es einen Installer für Debian Linux (inklusive Caddy, PostgreSQL und HTTPS): core/deploy/linux/install.sh. Updates spielt dort sudo modulstack-update ein. Anleitung: docs/backend/betrieb.md im Repository.

Wenn Sie nicht weiterkommen

Dokumentation

Die Doku liegt im Ordner docs/ des Repositorys, Einstieg ist docs/index.md. Mit npm run docs starten Sie eine lokale Vorschau auf 127.0.0.1:8001. Sie ist bisher auf Deutsch.

Forgejo

Fragen und Fehler melden Sie als Issue im Repository. Sicherheitslücken bitte nicht als Issue, sondern wie in SECURITY.md beschrieben.

Persönlicher Kontakt

Sie möchten nicht selbst entwickeln? Dann buchen Sie das kostenlose Erstgespräch, wir klären gemeinsam, wie wir Ihre App umsetzen.

FAQ

Häufige Fragen zum Start

Brauche ich Programmierkenntnisse?

Ja. Modulstack ist eine Basis für Entwickler. Wer Code ergänzt, muss ihn verstehen und auf Sicherheit prüfen können. Ohne diese Kenntnisse lassen Sie die App besser entwickeln, im kostenlosen Erstgespräch klären wir das.

Kann ich Modulstack erst ausprobieren?

Ja. Sie klonen das Repository auf Ihren eigenen Rechner und starten das mitgelieferte Starter-Produkt, eine App ohne Module. So sehen Sie, was schon fertig ist.

Wie lange dauert der Start?

Wenige Minuten: klonen, npm install und pip install (zusammen etwa eine Minute bei normaler Leitung), dann ./dev.sh und ein Konto anlegen.

Wie bleibt Modulstack aktuell?

Die Basis wird weiterentwickelt. Jede Version des Core kommt als ein Commit mit Tag ins Repository. Mit git fetch --tags und git merge holen Sie sie in Ihr Projekt. Ihr eigener Code liegt nur in modules/ und products/, dann bleibt jedes Update möglich.

Brauche ich Rust?

Nein, zum Starten nicht. Der Core hat einen Rust-Kern für sicherheitskritische Aufgaben, zum Beispiel das Einlesen von CSV, Excel, vCard und Word und die Prüfung von Signaturen. Ohne gebautes Rust-Paket läuft dieselbe Funktion in Python weiter. Wenn Sie den Rust-Teil selbst bauen wollen, installieren Sie Rust über rustup und starten npm run native.

Bereit für Ihr erstes Tool?

Holen Sie sich Modulstack von Forgejo und starten Sie auf einem fertigen Fundament.

Zum Repository auf Forgejo →
Nach oben scrollen