savannabits/acacia

Modular Backend Code Generation Engine for laravel 9.2, Vue.js 3.x and Tailwindcss 3.x inspired. Inspired by nwidart/laravel-modules and savannabits/jetstream-inertia-generator

v1.4.0 2022-05-11 07:12 UTC

Requires

• php: ^8.0|^8.1
• doctrine/dbal: ^3.3
• illuminate/support: ^9.2
• inertiajs/inertia-laravel: ^0.5
• laravel/breeze: ^v1.8
• laravel/framework: ^v9.5.1
• laravel/sanctum: ^2.14
• laravel/scout: ^9.4
• laravel/tinker: ^v2.7
• maatwebsite/excel: ^3.1.37
• savannabits/primevue-datatables: ^v1.3
• spatie/laravel-permission: ^5.5
• tightenco/ziggy: ^1.0

Requires (Dev)

• barryvdh/laravel-ide-helper: ^2.12
• mockery/mockery: ~1.0
• orchestra/testbench: ^v7.0.0
• phpstan/phpstan: ^1.4.6
• phpunit/phpunit: ^9
• spatie/phpunit-snapshot-assertions: ^4.2.10

MIT

• Samson Maosa

• generator
• module
• modules
• crud
• laravel
• savannabits

README

savannabits/acacia (an improved successor to savannabits/jetstream-inertia-generator) is a Backend Modular Code and CRUD generator for Laravel 9. The code is generated in the following stack:

• Laravel ^9
• Inertia.js
• Laravel Breeze & Sanctum
• Vue.js ^3
• Tailwindcss ^3
• PrimeVue ^3.11

Before Installation

Before you begin installation, you have to prepare your laravel app by installing the following:

1. Install and Configure Laravel Sanctum Follow these Steps
2. Install and configure Laravel Breeze as the authentication package Follow these steps
3. Install and configure spatie/laravel-permission. Follow these Steps
4. Install and configure laravel/scout. By default, acacia will try to configure the basic database driver for scout during installation. Follow Scout Installation steps

Now you are ready to install Acacia! Don't worry, acacia will be installed as a separate modular component, with its own frontend assets and even compilation process using vite.js, all separate from your main app, allowing you to even mix two frontend stacks together!

Install

To install through Composer, by run the following command:

composer require savannabits/acacia -W

By default, the Acacia's classes are not loaded automatically. Before proceeding with installation, autoload the Acacia namespace and backend modules using psr-4 by adding the following to your app's composer.json:

{
  "autoload": {
    "psr-4": {
        "App\\": "app/",
        "Database\\Factories\\": "database/factories/",
        "Database\\Seeders\\": "database/seeders/",
        "Acacia\\": "acacia/"
    }
  }
}

Tip: don't forget to run composer dump-autoload afterwards.

The package will automatically register its service providers. Then install the necessary files for code generation and backend by running:

php artisan acacia:install

Top: If you would like to force the replacement of existing Acacia files, add the --force option to the command above From here, you are ready to generate code and interact with your new backend.

Preview & Documentation

See a Preview or sample of the backend that you will get using this package HERE.

Username: [e-mail]
Password: password

You'll find installation instructions and full documentation on https://acacia.savannabits.com/docs.

Credits

• Sam Maosa
• Savannabits Ltd

License

The MIT License (MIT). Please see License File for more information.