moox

Moox-Projekt

Willkommen beim Moox-Projekt. Dies ist eine Monorepo- und installierbare Laravel-App zur Entwicklung unserer Filament-Plugins, auch bekannt als Laravel-Pakete. Wir befinden uns in einem frühen Entwicklungsstadium, aber es gibt bereits einige Plugins, die Sie für nützlich halten könnten:

Pakete

• Moox Skeleton, unser Skeleton-Paket zur Erstellung neuer Filament-Plugins
• Moox Builder, unser Builder-Paket zum Erstellen von Filamentressourcen
• Moox Core, der für alle unsere Pakete erforderlich ist, liefert allgemeine Dinge
• Moox-Jobs, verwalten Sie Job-Warteschlangen, fehlgeschlagene Jobs und Stapel in Filament

Einige sind im produktiven Einsatz, aber noch nicht dokumentiert:

• Moox Expiry: Definieren und automatisieren Sie den Ablauf Ihrer Datensätze
• Moox User Device, verwalten Sie die Geräte Ihrer Benutzer und entscheiden Sie, wie mit Unbekannten umgegangen werden soll
• Moox User Session, verwalten Sie die Sitzung Ihrer Benutzer (auch im Kontext von Geräten)

Alle anderen Pakete befinden sich in der intensiven Entwicklung:

• Moox Audit, Protokollierung und Auditierung, sicherheitsbezogen und modellbezogen
• Moox Flags, Flags enthält Blade-Icons für Länder, Sprachen und mehr
• Moox Locate, Länder, Sprachen, Währungen, Länderpräfixe, Zeitzonen
• Moox Login Link, senden Sie Login-Links (auch bekannt als Magic Links) an Ihre Benutzer
• Moox Page, Inhaltsverwaltung, derzeit aufgegeben, da wir Press verwenden
• Moox Passkey, geben Sie Benutzern die Möglichkeit, Passkeys zu verwenden (Webauthn)
• Moox Permission, verwalten Sie Rollen und Berechtigungen mit Spatie Permission
• Moox Press, verwenden Sie WordPress, ohne WordPress zu verwenden, in Filament
• Moox Redis Model, nutzen Sie Redis als Plug-in-Ersatz für Ihre Modelle
• Moox Security, verwalten Sie Ihre Passwortsicherheit und andere Sicherheitsfunktionen
• Moox Sync, Datensätze von Server zu Server synchronisieren, Logik und Transformatoren hinzufügen
• Moox Trainings, automatisieren Sie Schulungen, Einladungen und Selbstvalidierung
• Moox-Benutzer, verwalten Sie Ihre Benutzer in Filament und gewähren Sie Benutzern Zugriff auf ihr Profil

Und es gibt noch einige andere Dinge, die NICHT in diesem Repo enthalten sind:

• Moox DevOps, Verwalten Sie Ihre Forge-Server, Sites und Bereitstellungen
• Moox Backup Server-Benutzeroberfläche, Filament-Benutzeroberfläche für Spatie Laravel Backup Server
• Moox VS Code Extensions, unser VS-Code-Erweiterungspaket für Filament-Entwickler

Installation

Die Laravel-Entwickler-App im Stammordner des Moox Monorepo ist für die sofortige Entwicklung mit Laravel Herd, Laravel Valet, Laravel Sail oder Laragon konzipiert.

 # Create a .env file and adjust to your needs
cp .env.example .env

# Don't forget to create the database according .env

# Install via Composer
composer install

# Migrate and seed
php artisan migrate:fresh --seed

# Use Vite (for Laravel Sail on Windows: do it in Ubuntu, not inside the Sail container)
npm install
npm run dev

Optionale Dinge:

 # You can create a user then
php artisan make:filament-user

# You can use the custom composer.json
cp _custom/composer.json-example _custom/composer.json

# Run Sail (alternatively start Herd,Laragon or Valet)
./vendor/bin/sail up

# Rebuild the sail config if needed
./vendor/bin/sail down --rmi all -v
php artisan sail:install

# Remove broken symlinks if needed
# switching from Laragon to Sail for example
rm -Rf vendor/mooxphp

Der Moox Admin ist ab sofort unter /moox verfügbar, z. B. https://moox.test/moox

Moox Press

Um Moox Press zu installieren, benötigen Sie ein WordPress, das in /public/wp (oder einem anderen Unterverzeichnis, konfiguriert in .env) läuft.

Installieren Sie ein neues WordPress

Um ein neues WordPress zu installieren, stellen wir einen handwerklichen Befehl bereit, der im Moox Press-Paket enthalten ist:

php artisan mooxpress:wpinstall

Der Befehl benötigt etwas Optimierung und läuft unter Windows nur „zur Hälfte“.

Benutzerdefinierte Pakete

Unser Monorepo ist darauf vorbereitet, ein Doppelagent zu sein:

• Entwickeln Sie ein privates oder öffentliches Projekt
• während er zum Moox-Projekt beitrug

Dies geschieht durch die Unterstützung benutzerdefinierter Pakete in der Entwicklungs-App unseres Monorepo. Klingt interessant? Lesen Sie weiter unter _custom/README.md.

Entwicklung

• Führen Sie npm run build vor dem Commit aus, da für automatisierte Tests auf GitHub ein funktionierendes Vite-Manifest erforderlich ist
• Führen Sie php artisan migrate --database=sqlite um Änderungen an der Testdatenbank widerzuspiegeln
• Verwenden Sie https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind mit VS-Code
• Verwenden Sie https://github.com/mooxphp/builder, um Ihre eigenen Pakete zu erstellen
• Weitere Informationen finden Sie unter BEITRAGEN.

Verzweigung

• main ist die aktuelle stabile Version, branchengeschützt, automatische Festschreibung für alle Pakete, bereitgestellt auf li
• feature/... Bitte stellen Sie allen Feature-Branches ein Präfix voran und erstellen Sie Ihre Pull-Anfragen direkt in main

Verwenden Sie problembasierte Zweige und stellen Sie ihnen „feature/“ voran (z. B. „feature/38-welcome-view“) für automatisierte Tests und Codeanalysen.

Commits

Ihre Commit-Nachrichten werden in Changelog.md zusammengeführt, d. h. sie werden Teil der Dokumentation. Bitte stellen Sie sicher, dass Sie

• Beginnen Sie mit einem dieser Typen
  • Bump = geringfügige Versionsänderung, größer bei Verwendung als Bump!
  • Bereinigen = alte Inhalte oder nicht verwendeten Code löschen
  • Deps = sich ändernde Abhängigkeiten
  • Devops = GH und Automatisierung
  • Dokumente = Dokumentation
  • Feat = Feature
  • Fix = Bugfix
  • Lang = Übersetzung
  • Tests = Tests schreiben
  • Wip = in Arbeit
• Für wichtige Änderungen fügen Sie „!“ hinzu. zu jedem Typ, um eine Hauptversion zu erstellen
• gefolgt vom Kurznamen des Pakets, in []
  • Alle – mehrere oder alle Pakete
  • Repo – Monorepo-Dinge
  • Kern
  • Baumeister
  • Jobs
  • ...
• Verweisen Sie auf ein Problem, verknüpft mit der Problemnummer, z. B. #138
• Bereiten Sie das automatische Schließen des Problems vor, indem Sie „Schließen #138“ verwenden.

Gültige Beispiele

• Wip[Core]: Feature register assets wip #123
• Fix[All]: Update all packages Close #321
• Feat[Monorepo]: Update dev app Close #22
• Bump![ChartComponents]: Major Updates
• Feat![PackageBuilder]: This will become a major release #23

Lesen Sie mehr über konventionelle Commits.

Pull-Anfragen

Erstellen Sie eine PR für main . Verwenden Sie herkömmliche Commits wie oben erläutert.

Semver

Wir verwenden semantische Versionierung, geschrieben wie 1.2.3 für

1. Hauptveröffentlichungen
2. Kleinere Veröffentlichungen
3. Bugfix-Releases

Weitere Informationen finden Sie auf Semver.org.

Veröffentlichungen

Wird derzeit manuell durchgeführt, eine automatische Freigabefunktion ist in Vorbereitung.

Testen

Wir testen Moox mit:

• Monorepo
  • Larastan, PHPStan Level 5
  • Laravel Pint, PHP CS Fixer
  • Codacy und Code-Klima
• Pakete
  • Larastan, PHPStan Level 5
  • Laravel Pint, PHP CS Fixer
  • Pest

Bitte stellen Sie sicher, dass Sie die gleichen Tools in VS Code verwenden (unser VS Code Extension Pack deckt dies ab) oder führen Sie die Prüfungen manuell durch, bevor Sie sich auf den Entwicklungszweig festlegen:

• PHPStan: composer analyse oder ./vendor/bin/phpstan analyse für Pakete ../../vendor/bin/phpstan analyse
• Schädling: composer test oder ./vendor/bin/pest für Pakete ../../vendor/bin/pest
• Abdeckung: composer test-coverage oder ./vendor/bin/pest --coverage für Pakete ../../vendor/bin/pest --coverage
• Pint: composer format oder ./vendor/bin/pint für Pakete ../../vendor/bin/pint

Admin-Navigation

Titel und Sortierung im AdminPanel können in den Paketkonfigurationen angepasst werden, aber dies ist die Standardsortierung, die alles an Ort und Stelle hält:

 - Dashboard
- Main - 1000
    - Expiry - 1100
    - Notifications - 1800
- Content - 2000
    - Posts - 2100
    - Pages - 2200
    - Media - 2300
    - Categories - 2400
    - Tags - 2500
    - Comments - 2600
- Custom - 3000
    - ...
- Meta - 4000
    - Wp Meta...
- Custom - 5000
    - ...
- Users - 6000
    - App users - 6010 (Moox Users, Moox Press Users 6015)
    - Site users - 6020
    - Customers - 6030
    - Registrations - 6100
    - Roles - 6200
    - Permissions - 6201
    - Devices - 6300
    - Sessions - 6400
    - Login-Links - 6500
    - Password-Tokens - 6600
    - Passkeys - 6700
- System - 7000
    - Audit - 7500
    - Options (Press) - 7900
- Jobs - 8000
    - Job manager - 8001
    - ...
- Tools - 9000
    - Sync - 9500
    - Backup - 9800
    - Builder - 9990

Mitwirkende

Moox wird von diesen netten Leuten und Bots gemacht ...

Alf Drollinger ? ? ?️	Aziz Gasim ?️	KimSpeer ?️	Weblate (Bot) ?	Moox Bot ?	Reinhold Jesse	FMorlock ? ?
Sam Bola ?	Kim Speer ?️ ️	Laravel-Verschiebung ?	Mikagrich	somogyi.zoltan	Igor Clauss	Greg RG
Allan Nordhøy ?	Jana Brot	Milo Ivir ?	Mika	Alle Mitwirkenden ?	Freek Van der Herten ?	renovieren[bot] ?
Github-Aktionen[bot] ?	dependabot[bot] ?	Mikachu	simmon	Kalpesh Mahida	Rowlin	Mark van den Broek
Sebastian De Deyne	Peter Forret	Ettore Atalan ?	p-paul	Salh

Diese Tabelle wird vom All Contributors Bot generiert. Um Mitwirkende hinzuzufügen, verwenden Sie den folgenden Befehl in einem beliebigen Kommentar zu einem Problem oder einer PR:

@all-contributors please add @github-user for code

Normalerweise verwenden wir „Code“ und „Übersetzung“, aber auf AllContributers.org sind auch andere mögliche Typen aufgeführt. Bitte stellen Sie jeweils nur eine Anfrage, da es zu Zusammenführungskonflikten kommt, wenn Sie versuchen, mehrere Mitwirkende hinzuzufügen, ohne dazwischen die PR zusammenzuführen.

Beitragen

Wir freuen uns über jeden Beitrag! Es wäre großartig, wenn du:

• Erstellen Sie im Repo ein Problem, das am besten passt, und fügen Sie Informationen zum Problem oder zur Idee hinzu. Wir werden innerhalb weniger Tage antworten.
• Erstellen Sie in diesem Monorepo eine Pull-Anfrage. Bitte wenden Sie sich nicht an unsere schreibgeschützten Repos, da diese nicht auf Codeänderungen vorbereitet sind. Nur das Monorepo verfügt über Quality Gates und automatisierte Tests.
• Übersetzen Sie Moox mit Weblate.
• Erzählen Sie anderen von Moox oder verlinken Sie uns.
• Erwägen Sie eine Spende oder eine Patenschaft.

Übersetzung

Moox wird mit Weblate übersetzt. Natürlich können Sie die Übersetzungsdateien auch direkt in den Paketen bearbeiten, aber die Verwendung einer voll ausgestatteten Übersetzungsplattform wie Weblate könnte bequemer sein.

Lizenz

Moox ist eine kostenlose Open-Source-Software, die unter der MIT-Lizenz lizenziert ist.

Einige der Projekte, von denen wir abhängig sind, werden unter einer anderen Lizenz veröffentlicht. Wir tun unser Bestes, um sicherzustellen, dass diese Lizenzen sowohl die private als auch die kommerzielle Nutzung ermöglichen und keine Einschränkungen auferlegen.

Wenn Sie ein Problem mit der Moox-Lizenzierung oder einer Abhängigkeit bemerken, senden Sie uns bitte eine E-Mail an [email protected].

Sicherheit

Wie oben erwähnt, verwenden wir automatisierte Codeprüfungen und Sicherheitsüberprüfungen, um sicherzustellen, dass unser Code keine Sicherheitslücken aufweist.

Lesen Sie unsere Sicherheitsrichtlinie, um mehr über Sicherheit zu erfahren oder eine potenzielle Schwachstelle zu melden. Bitte verwenden Sie den Issue-Tracker NICHT zum Melden sicherheitsrelevanter Probleme.