kirago/laravel-business-core

A Laravel business core multi-tenancies management data structure: orders, products, invoices, payments and more.

3.0.0 2025-06-08 01:41 UTC

Requires

• php: ^8.2
• ext-ctype: *
• ext-filter: *
• ext-json: *
• ext-mbstring: *
• ext-pdo: *
• axn/laravel-eloquent-authorable: ^6.3 || ^7.0
• barryvdh/laravel-dompdf: ^3.1
• calebporzio/sushi: ^2.5
• cviebrock/eloquent-sluggable: ^11.0 || ^12.0
• laravel-json-api/laravel: ^5.0 || ^5.1
• laravel-notification-channels/webpush: ^10.2
• laravel/framework: ^11.0 || ^12.0
• laravel/sanctum: ^4.1
• simplesoftwareio/simple-qrcode: ^4.2
• spatie/laravel-activitylog: ^4.9 || ^4.10
• spatie/laravel-medialibrary: ^11.10 || ^11.13
• spatie/laravel-permission: ^6.9 || ^6.19
• spatie/laravel-sluggable: ^3.6 || ^3.7
• spatie/laravel-translatable: ^6.11
• spatie/valuestore: ^1.3
• staudenmeir/eloquent-has-many-deep: ^1.20 || ^1.21
• stevebauman/location: ^7.5

Requires (Dev)

• kirago/laravel-xpeedy-service: dev-main

MIT

• Simo Joel

• product
• payment
• order
• invoice
• laravel
• core
• business
• billing
• multi-tenant
• jsonapi
• tenancy
• multi-tenancy
• laravel-package
• kirago
• business-core

README

📖 Introduction

Laravel Business Core est un package modulaire et extensible pour Laravel, conçu pour fournir les composants métiers fondamentaux nécessaires à la gestion d’applications professionnelles.

✨ Fonctionnalités principales

• 🛒 Commandes et lignes de commande
• 📦 Produits et packages
• 📄 Factures et lignes de facture
• 💰 Paiements et taxes
• 🧾 Abonnements et plans
• 👤 Clients et contacts
• 🧑‍💼 Utilisateurs, rôles et permissions
• 🌐 Prise en charge du multi-tenant
• ⚙️ Personnalisable via les fichiers publiés

Ce package est idéal pour les applications B2B, SaaS ou de type ERP.

📦 Installation

✅ Prérequis

• Laravel ^10.0 || ^11.0 || ^12.0
• PHP ^8.0
• Extensions PHP nécessaires :
  • json
  • ctype
  • filter
  • mbstring
  • pdo

📥 Étape 1 : Installation via Composer

composer require kirago/laravel-business-core

⚠️ Cas de ceux qui utilisent Laravel 12 avec PHP 8.3.x

A cause des mises à jour sur axn/laravel-eloquent-authorable:^7.0 qui requiert php ^8.4, si vous tombez sur cette erreur axn/laravel-eloquent-authorable 6.3.0 requires illuminate/support ^8.0 || ^9.0 || ^10.0 || ^11.0 -> satisfiable by illuminate/support[v8.0.0, ..., v8.83.27, v9.0.0, ..., v9.52.16, v10.0.0, ..., v10.48.28, v11.0.0, ..., v11.45.1]. alors exécutez ceci pour bypasser la verification de version de php par composer

composer require kirago/laravel-business-core --ignore-platform-reqs

🛠 Étape 2 : Initialisation complète

La commande suivante publie les fichiers nécessaires et installe la structure de base :

php artisan bc:setup

Cette commande effectue les actions suivantes :

• 📂 Publication des fichiers de configuration (config/business-core.php, config/bc-data/)
• 🧱 Publication et exécution des migrations
• 💱 Installation des données de devises
• 🔐 Création du rôle "Super Admin" et des permissions
• 🧹 Nettoyage et mise en cache de la configuration Laravel

🧩 (Optionnel) Publication des dossiers du noyau

🔧 Configuration

Le fichier principal de configuration est :

config/business-core.php

Vous pouvez y configurer :

• Les modèles utilisés
• Les modèles traçables (authorable)
• Les données par défaut (pays, taxes, etc.)
• Les intégrations éventuelles (permissions, paiements, etc.)

🧠 Personnalisation

Vous pouvez surcharger les modèles, contrôleurs ou actions du package :

1. Activez la personnalisation dans config/business-core.php

return [

    // 🔧 Active ou non la personnalisation des fichiers du package
    'customization' => true,
    
    ...

1. Publiez les dossiers :

php artisan bc:publish-core-folders

Cela publiera les dossiers suivants dans app/ :

• app/Modules
• app/Support
• app/JsonApi

1. Modifiez les classes selon vos besoins

Cela permet une personnalisation avancée tout en gardant une base solide.

🛣 (Optionnel) Découverte automatique des routes JSON:API

Pour activer la découverte des routes JSON:API fournies par le package, ajoute la ligne suivante dans la méthode boot() de ton App\Providers\AppServiceProvider :

use Kirago\BusinessCore\Facades\BusinessCore;

public function boot(): void
{
    BusinessCore::discoverApiRoutes(prefix: 'v1');
}

Verifiez que les routes sont bien disponibles

php artisan route:list --path=api

Resultat

  .....
  
  POST       api/v1/auth/forgot-password/request ................................... bc.auth.forgot-password.request › Kirago\BusinessCore › PasswordResetController@request
  POST       api/v1/auth/forgot-password/reset ......................................... bc.auth.forgot-password.reset › Kirago\BusinessCore › PasswordResetController@reset  
  POST       api/v1/auth/login ................................................................................. bc.auth.login › Kirago\BusinessCore › LoginController@login  
  POST       api/v1/auth/logout ............................................................................. bc.auth.logout › Kirago\BusinessCore › LogoutController@logout 
  
  .....

📝 Licence

Ce package est open-source et distribué sous licence MIT.

🤝 Contribuer

Les contributions sont les bienvenues !
N’hésitez pas à soumettre une pull request ou à ouvrir une issue pour signaler un bug ou proposer une amélioration.

👤 Auteur

Kirago
Développé avec ❤️ pour les artisans Laravel.