Erste Schritte
BoxLang installieren, die Vorlage klonen, deine Datenbank konfigurieren und den Login-Bildschirm öffnen.
Auf dieser Seite
Erste Schritte
Systemanforderungen
- Java 21+ (JDK oder JRE)
- BoxLang 1.17+
- CommandBox 7+ (
bx-cli) - Node.js 22+ (für das Vite-Frontend)
- Eine unterstützte Datenbank: MySQL 8+ (Standard), MariaDB, PostgreSQL, SQLite, Oracle oder MSSQL
- Ein beliebiges Betriebssystem
BoxLang installieren
MacOS & Linux
# macOS & Linux
/bin/bash -c "$(curl -fsSL https://install.boxlang.io)"
# ...with automatic Java 21 installation
curl -fsSL https://install.boxlang.io | bash -s -- --with-jre
Windows
powershell -NoExit -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://install-windows.boxlang.io'))"
Verwende stattdessen BVM, wenn du zwischen mehreren BoxLang-Versionen wechseln musst:
curl -fsSL https://install-bvm.boxlang.io | bash
bvm install latest && bvm use latest
Installation überprüfen:
boxlang --version
CBGenesis ist eine BoxLang-Vorlage. Installiere nicht die standardmäßige Lucee-basierte CommandBox-Distribution. Installiere nach der BoxLang-Installation mit dem Schnellinstaller oder BVM das BoxLang-native CLI-Modul. Dies ist erforderlich, bevor du box install, box server, box migrate oder box testbox ausführst:
install-bx-module bx-cli
Überprüfe, dass die BoxLang-CLI aktiv ist:
box version
Aktuelle Entwickler, die die Lucee-basierte CommandBox-Distribution verwenden, sollten zwischengespeicherte Artefakte bereinigen, um sicherzustellen, dass sie die neuesten Versionen der erforderlichen Module nutzen:
box artifacts clean
Wird box nach der Installation nicht gefunden, starte das Terminal neu oder füge das vom Installer gemeldete Verzeichnis zu deinem PATH hinzu.
Deine App aufbauen
Öffne die CommandBox-Shell, indem du zuerst box eingibst:
install coldbox-cli
coldbox create app name="my-app" skeleton="cbgenesis"
!npm install
Öffne die .env-Datei in deinem bevorzugten Texteditor und aktualisiere die Datenbank-Zugangsdaten entsprechend. Die Vorlage wird vorkonfiguriert für MySQL ausgeliefert. MySQL, MariaDB, PostgreSQL und MSSQL sind unterstützte und getestete Datenbankziele. onServerInitialInstall in server.json installiert beim ersten Ausführen von box server start das JDBC-Treibermodul passend zu deiner DB_DRIVER-Einstellung (bx-${DB_DRIVER}, standardmäßig bx-mysql). Um eine andere Datenbank zu verwenden, setze DB_DRIVER in .env vor diesem ersten Serverstart
Sobald deine .env gesetzt ist, führe die folgenden Befehle aus, um die Datenbank zu initialisieren und zu seeden. Die benötigten Treiber sollten automatisch heruntergeladen werden, um die CLI mit der konfigurierten Datenbank zu verbinden. Falls es Verbindungsprobleme gibt, stelle sicher, dass der richtige DB_DRIVER gesetzt und das entsprechende JDBC-Treibermodul installiert ist.
migrate init
migrate up --seed
resources/database/seeds/AdminData.bx erstellt eine Admin-Rolle mit allen 20 eingebauten Berechtigungen sowie einen Admin-Benutzer:
| Feld | Wert |
|---|---|
admin@cbgenesis.com | |
| Passwort | test (reset-pending) |
Dieses Konto wird als reset-pending eingesät, sodass die Anmeldung mit test dir keine Session gibt - sie führt dich direkt zum Formular für die Passwort-Zurücksetzung, um ein echtes Passwort zu wählen. Das ist beabsichtigt: Der Bootstrap-Hash wird in diesem Repository mitgeliefert und ist öffentlich. Siehe die Produktions-Checkliste.
CBGenesis liefert vorkonfigurierte KI-Guidelines, Skills und Agentendateien in .agents/ mit, sodass Assistenten wie GitHub Copilot, Cursor und Claude Code korrekten ColdBox- und BoxLang-Kontext erhalten. Sie werden vom coldbox-cli-Modul erzeugt, das du im Scaffold-Schritt installiert hast. Aktualisiere sie nach dem Scaffolding, damit die Guidelines und Skills zu deinen installierten Modulen passen:
coldbox ai refresh
Führe coldbox ai refresh erneut aus, wann immer du CommandBox-Module installierst, aktualisierst oder entfernst, damit modulspezifische Guidelines und Skills übernommen werden.
coldbox ai --help # Discover the available AI commands
coldbox ai info # Show installed guidelines, skills, agents, and MCP servers
coldbox ai skills list # List the available skills
coldbox ai agents --help # Add, update, or remove AI agent configuration files
server start
Dies ist der BoxLang-CLI-Serverbefehl. Beim ersten Ausführen werden die in server.json gelisteten BoxLang-Module installiert (bx-esapi, bx-password-encrypt, bx-mail, bx-orm, der durch DB_DRIVER ausgewählte JDBC-Treiber sowie bx-image).
onServerInitialInstall feuert nur beim allerersten Start eines Servers, sodass eine spätere Änderung von DB_DRIVER den Treiber nicht von selbst neu installiert. Führe server forget aus (das den Installationsstatus des Servers löscht), bevor du ihn erneut startest, damit der neue Treiber installiert wird:
server forget
server start
npm run dev
Die App öffnen
Besuche http://127.0.0.1:8080 - du landest auf der Login-Seite. Melde dich mit den oben eingesäten Admin-Zugangsdaten an.
AuthSplit.Sobald du angemeldet bist, landest du auf dem Dashboard, mit der Admin-Seitenleiste bereit für Benutzer, Rollen, Berechtigungen, Audit-Log und Einstellungen:
Sieh, wie public/, app/, resources/ und lib/ zusammenpassen, und geh den Request-Lebenszyklus durch.
Verstehe den Login-Ablauf und das resource:action-Berechtigungsmodell, bevor du deine erste geschützte Seite hinzufügst.
Bereit zu bauen? Starte hier für die genauen Schritte, um ein neues CRUD-Modul hinzuzufügen.