Download the PHP package savannabits/charaza-ui without Composer

About Charaza UI

Looking for a Jetstream Tailwindcss, Inertia and Vue3 CRUD generator? Checkout our sister project, Jetstream Inertia Generator (Jig)

Charaza UI is a Laravel Starter that is integrated with savannabits/savadmin Admin Generator to enable you kickstart and rapidly develop your next laravel project. Equipped with the latest laravel tools, Charaza UI doesn't leave much of the boilerplate work to you. The auth module is scaffolded for you. The templates are setup for you. The routing is already set up for you. All you have to do is just start writing your modules' code. What is even better: you don't have to go through much trouble to generate fully operational modules including Models, API controllers, Datatable Controllers, API and backend routes, views for editing and showing, code for deleting... The savadmin generator does all this for you with a single command:

Features

• Code Generation with savannabits/savadmin
• Laravel 8 Scaffold
• Laravel Jetstream Frontend
• Livewire 2 Scaffold
• Laravel Fortify User Management
• Alpine.js working with Livewire to give you a true SPA experience with just Laravel blade!
• Backend and API Generation with Laravel and Vue.js (using BootstrapVue)
• Profile and Info and Update
• API Keys using Jetstream and Laravel Sanctum
• Optional DB cacheing
• Fuzzy Search using Laravel TNTSearch

  Installation

  Charaza UI is meant for easing your work when beginning new projects. To start an all powered-up new project, simply create it from charaza as follows:

Usage

The package comes with an optional docker configuration. It is highly recommended to use this to experience the full power with minimal configuration. After setting your .env variables, run the following to build and spin-up the docker containers:

This will boot up the app server exposed under the port you configured in the env. To enter the container's shell, there is a simple shell script included to enable this:

However, if you don't wish to use docker, no worry! All you have to do is configure database variables as you see fit, then proceed to the next step

Next, proceed with the normal laravel setup steps:

There you go! Your system is now setup and you are ready to create your next amazing app!

Code Generator:

Using the code generator to generate your commands is easy:

1. Create your migration file and edit it accordingly
2. Run the Migration
3. Use the generator to generate the model, controllers, routes, Menus, views and js assets.
4. Modify any of them as you wish (customize)
5. If you are not running yarn back-watch, then run yarn back-dev to rebuild the assets

Example:

Let us generate an Articles module from the articles table

1. Create the articles table

2. Edit the articles migration as you wish:

3. Run the migration

4. Use the generator to generate the model, controller, routes, menus, views and assets

NB If you already generated the files but would like to force overwrite use shell script php artisan sv:generate articles --force

Output:
![Articles](https://github.com/savannabits/charaza-ui/blob/master/storage/screenshots/Screenshot_20201120_091437.png?raw=false)
![Articles](https://github.com/savannabits/charaza-ui/blob/master/storage/screenshots/Screenshot_20201120_092032.png?raw=false)
![Articles](https://github.com/savannabits/charaza-ui/blob/master/storage/screenshots/Screenshot_20201120_092101.png?raw=false)
### Generated files

__app/Models/Article.php__

__app/Http/Controllers/Api/ArticleController.php__

__Appended Routes:__
api.php

web.php

__You can check the rest of the files as follows:__

- app/Http/Controllers/Admin/ArticleController.php
- resources/js/backend/articles.js
- resources/views/backend/articles/*

## Contributing

Thank you for considering contributing to the CharazaUI! Please email Savannabits <[email protected]> for more info.

## Code of Conduct

In order to ensure that the Charaza community is welcoming to all, please review and abide by the [Code of Conduct](https://savannabits.com).

## Security Vulnerabilities

If you discover a security vulnerability within Charaza, please send an e-mail to Sam Maosa via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## License

The Charaza UI Starter is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).