Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/savannabits/acacia
Backend Code Generator for Laravel 9, Vue 3 and Tailwindcss 3 using primevue
https://github.com/savannabits/acacia
acacia code crud generator jig laravel primevue savannabits tailwindcss vite vue
Last synced: about 2 months ago
JSON representation
Backend Code Generator for Laravel 9, Vue 3 and Tailwindcss 3 using primevue
- Host: GitHub
- URL: https://github.com/savannabits/acacia
- Owner: savannabits
- License: mit
- Created: 2022-02-23T15:30:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-11T07:14:12.000Z (over 2 years ago)
- Last Synced: 2024-04-20T00:44:20.121Z (8 months ago)
- Topics: acacia, code, crud, generator, jig, laravel, primevue, savannabits, tailwindcss, vite, vue
- Language: Vue
- Homepage: https://acacia.savannabits.com
- Size: 2.02 MB
- Stars: 39
- Watchers: 2
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# acacia
[](https://packagist.org/packages/savannabits/acacia)
[](LICENSE.md)
[](https://travis-ci.org/savannabits/acacia)
[](https://packagist.org/packages/savannabits/acacia)
`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](https://laravel.com/docs/9.x/sanctum#installation)
2. Install and configure Laravel Breeze as the authentication package [Follow these steps](https://laravel.com/docs/9.x/starter-kits#laravel-breeze-installation)
3. Install and configure `spatie/laravel-permission`. [Follow these Steps](https://spatie.be/docs/laravel-permission/v5/installation-laravel)
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](https://laravel.com/docs/9.x/scout#installation)
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:
```bash
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:
``` 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:
```bash
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](https://acacia.savannabits.com/backend).
Username: `[email protected]`
Password: `password`
You'll find installation instructions and full documentation on [https://acacia.savannabits.com/docs](https://acacia.savannabits.com/docs).
## Credits
- [Sam Maosa](https://github.com/coolsam726)
- [Savannabits Ltd](https://github.com/savannabits)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.