moox

Projet Moox

Bienvenue dans le projet Moox. Il s'agit d'une application Laravel Monorepo et installable pour développer nos plugins Filament, également appelés packages Laravel. Nous en sommes à un stade précoce de développement mais il existe déjà quelques plugins que vous pourriez considérer utiles :

Forfaits

• Moox Skeleton, notre package Skeleton pour créer de nouveaux plugins de filaments
• Moox Builder, notre package Builder pour créer des ressources de filaments
• Moox Core, requis par tous nos packages, contient des éléments courants
• Moox Jobs, gérez les files d'attente de tâches, les tâches ayant échoué et les lots dans le filament

Certains sont utilisés de manière productive mais ne sont pas encore documentés :

• Moox Expiry, définissez et automatisez l'expiration de vos dossiers
• Moox User Device, gérez les appareils de vos utilisateurs et décidez comment gérer les inconnus
• Moox User Session, gérez la session de vos utilisateurs (également dans le contexte des appareils)

Tous les autres packages sont en cours de développement intensif :

• Moox Audit, journalisation et audit, liés à la sécurité et aux modèles
• Moox Flags, Flags contient des icônes de lame pour les pays, les langues et plus encore
• Moox Locate, pays, langues, devises, préfixes de pays, fuseaux horaires
• Lien de connexion Moox, envoyez des liens de connexion (alias liens magiques) à vos utilisateurs
• Moox Page, gestion de contenu, actuellement abandonnée car nous utilisons Presse
• Moox Passkey, donne aux utilisateurs la possibilité d'utiliser des clés d'accès (Webauthn)
• Moox Permission, gérez les rôles et les autorisations à l'aide de Spatie Permission
• Moox Press, utilisez WordPress sans utiliser WordPress, dans Filament
• Modèle Moox Redis, utilisez Redis comme plug-in de remplacement pour vos modèles
• Moox Security, gérez la sécurité de votre mot de passe et d'autres fonctionnalités de sécurité
• Moox Sync, synchronisez les enregistrements de serveur à serveur, ajoutez de la logique et des transformateurs
• Moox Trainings, automatisez les formations, les invitations et l'auto-validation
• Moox User, gérez vos utilisateurs dans Filament et donnez aux utilisateurs l'accès à leur profil

Et il y a d'autres éléments qui ne figurent PAS dans ce dépôt :

• Moox DevOps, gérez vos serveurs Forge, sites et déploiements
• Interface utilisateur du serveur de sauvegarde Moox, interface utilisateur Filament pour le serveur de sauvegarde Spatie Laravel
• Moox VS Code Extensions, notre pack d'extension de code VS pour les développeurs Filament

Installation

L'application de développement Laravel dans le dossier racine de Moox Monorepo est conçue pour un développement instantané avec Laravel Herd, Laravel Valet, Laravel Sail ou Laragon.

 # 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

Choses facultatives :

 # 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

L'administrateur Moox est maintenant disponible sur /moox, par exemple https://moox.test/moox

Presse Moox

Pour installer Moox Press, vous avez besoin d'un WordPress exécuté dans /public/wp (ou un autre sous-répertoire, configuré dans .env).

Installez un nouveau WordPress

Pour installer un nouveau WordPress, nous fournissons une commande artisanale, livrée avec le package Moox Press :

php artisan mooxpress:wpinstall

La commande nécessite une certaine optimisation et ne s'exécute que "à moitié" sous Windows.

Forfaits personnalisés

Notre Monorepo est prêt à être un agent double :

• Développer un projet privé ou public
• tout en contribuant au projet Moox

Cela se fait en prenant en charge les packages personnalisés dans l'application de développement de notre Monorepo. Cela semble intéressant ? Lisez sur _custom/README.md.

Développement

• npm run build avant de vous engager car les tests automatisés sur GitHub ont besoin d'un vite-manifest fonctionnel
• Est-ce que php artisan migrate --database=sqlite pour refléter les modifications apportées à la base de données de test
• Utilisez https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind avec VS Code
• Utilisez https://github.com/mooxphp/builder pour créer vos propres packages
• Veuillez consulter CONTRIBUER pour plus de détails.

Ramification

• main est la version stable actuelle, protégée par branche, validée automatiquement sur tous les packages, déployée sur li
• feature/... veuillez préfixer toutes les branches de fonctionnalités, créez vos demandes d'extraction directement dans main

Utilisez des branches basées sur des problèmes, préfixez-les avec feature/ (par exemple feature/38-welcome-view) pour les tests automatisés et l'analyse du code.

S'engage

Vos messages de validation seront fusionnés dans Changelog.md, ce qui signifie qu'ils feront partie de la documentation. Veuillez vous assurer que vous

• commencez par l'un de ces types
  • Bump = changement de version mineur, majeur si utilisé comme Bump !
  • Clean = suppression des anciens éléments ou du code inutilisé
  • Deps = changer les dépendances
  • Devops = GH et automatisation
  • Docs = documentation
  • Exploit = ​​fonctionnalité
  • Correction = correction d'un bug
  • Lang = traduction
  • Tests = écriture de tests
  • Wip = travail en cours
• pour les changements cassants, ajoutez "!" à n'importe quel type pour créer une version majeure
• suivi du nom court du package, entre []
  • Tout – plusieurs ou tous les forfaits
  • Repo - Choses Monorepo
  • Cœur
  • Constructeur
  • Emplois
  • ...
• faire référence à un problème, lié par un numéro de problème, par exemple #138
• préparez la fermeture automatique du problème en utilisant "Fermer #138"

Exemples valables

• 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

En savoir plus sur les commits conventionnels.

Demandes de tirage

Créez un PR vers main . Utilisez des commits conventionnels comme expliqué ci-dessus.

semver

Nous utilisons le versioning sémantique, écrit comme 1.2.3 pour

1. Sorties majeures
2. Versions mineures
3. Versions de correction de bugs

Visitez Semver.org pour plus d’informations.

Sorties

Actuellement effectué manuellement, une fonctionnalité de publication automatique est en cours.

Essai

Nous testons Moox en utilisant :

• Monorepo
  • Larastan, PHPStan Niveau 5
  • Laravel Pint, fixateur PHP CS
  • Climat Codacy et Code
• Forfaits
  • Larastan, PHPStan Niveau 5
  • Laravel Pint, fixateur PHP CS
  • Ravageur

Veuillez vous assurer que vous utilisez les mêmes outils dans VS Code (notre pack d'extension VS Code couvre cela) ou effectuez les vérifications manuellement avant de vous engager dans la branche de développement :

• PHPStan : composer analyse ou ./vendor/bin/phpstan analyse , pour les packages ../../vendor/bin/phpstan analyse
• Pest : composer test ou ./vendor/bin/pest , pour les packages ../../vendor/bin/pest
• Couverture : composer test-coverage ou ./vendor/bin/pest --coverage , pour les packages ../../vendor/bin/pest --coverage
• Pint : composer format ou ./vendor/bin/pint , pour les packages ../../vendor/bin/pint

Navigation administrateur

Les titres et le tri dans l'AdminPanel peuvent être ajustés dans les configurations des packages, mais c'est le tri par défaut qui maintient tout en place :

 - 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

Contributeurs

Moox est fait par ces gens sympas, et des robots...

Alf Drollinger ? ? ?️	Aziz Gassim ?️	Kim Speer ?️	Weblate (bot) ?	Bot Moox ?	Reinhold Jesse	FMorlock ? ?
Sam Bola ?	Kim Speer ?️ ️	Changement Laravel ?	mikagrich	somogyi.zoltan	Igor Clauss	Greg RG
Allan Nordhoy ?	Jana Brot	Milo Ivir ?	Mika	Tous les contributeurs ?	Freek Van der Herten ?	rénover[bot] ?
actions github[bot] ?	dépendbot[bot] ?	Mikachu	Simon	Kalpesh Mahida	Rowlin	Mark van den Broek
Sébastien De Deyne	Pierre Forret	Ettore Atalán ?	p-paul	Salh

Ce tableau est généré par All Contributors Bot. Pour ajouter des contributeurs, utilisez la commande suivante dans tout commentaire d'un problème ou d'un PR :

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

Nous utilisons généralement « code » et « traduction », mais il existe d'autres types possibles répertoriés sur AllContributers.org. Veuillez ne faire qu'une seule demande à la fois, car nous rencontrerons des conflits de fusion si vous essayez d'ajouter plusieurs contributeurs sans fusionner le PR entre les deux.

Contribuer

Nous apprécions chaque contribution! Ce serait génial si vous :

• Créez un problème dans le dépôt qui vous convient le mieux et ajoutez des informations sur le problème ou l'idée. Nous vous répondrons dans quelques jours.
• Créez une Pull Request dans ce Monorepo. Veuillez ne pas faire de relations publiques vers nos dépôts en lecture seule, ils ne sont pas préparés aux modifications de code. Seul le monorepo dispose de portes de qualité et de tests automatisés.
• Traduisez Moox à l'aide de Weblate.
• Parlez de Moox à d’autres personnes ou créez un lien vers nous.
• Envisagez un don ou un parrainage.

Traduction

Moox est traduit avec Weblate. Bien sûr, vous pouvez également modifier directement les fichiers de traduction dans les packages, mais utiliser une plateforme de traduction complète comme Weblate pourrait être plus pratique.

Licence

Moox est un logiciel Open Source gratuit sous licence MIT.

Certains des projets dont nous dépendons sont publiés sous une licence différente. Nous faisons de notre mieux pour nous assurer que ces licences permettent une utilisation aussi bien privée que commerciale et n'imposent aucune restriction.

Si vous remarquez un problème avec la licence Moox ou une dépendance, veuillez nous envoyer un e-mail à [email protected].

Sécurité

Comme mentionné ci-dessus, nous utilisons des vérifications de code automatisées et des audits de sécurité pour garantir que notre code est exempt de failles de sécurité.

Lisez notre politique de sécurité pour en savoir plus sur la sécurité ou signaler une vulnérabilité potentielle. Veuillez NE PAS utiliser l'outil de suivi des problèmes pour signaler des problèmes liés à la sécurité.