kamansoft/klorchid

A orchid/platform package to speed up Kamansoft backofice php applications

dev-lemys_dev 2022-04-18 01:35 UTC

Requires

• php: ^7.4|^8.0
• datakrama/eloquid: ^2.0
• kamansoft/platform-multiorg: dev-main
• laravel-lang/lang: ~8.0

Requires (Dev)

• barryvdh/laravel-debugbar: ^3.5

MIT

• lemys lopez

README

Klorchid

A group of classes to ease the back-office development with laravel/Orchid.

this package is made with the intention to help in your RAPID web development with orchid mainly by providing extra laravel model traits, and extending Orchid's Screens classes

Installing Dependencies

The next list of commands must be executed in strictly in the order they are mentioned as packages needed by klorchid:

Klorchid needs 8.0 version of php, also some extensions

As all identificators are uuids you need:

• ext-ctype
• ext-gmp
• ext-bcmath

they can be installed on debian/ubuntu with:

sudo apt-get install php8.0-ctype php8.0-gmp php8.0-bcmath

Create a new laravel Project

$ composer create-project laravel/laravel brand_new_laravel_project "8.*" --prefer-dist

Cd to your newly created laravel project

$ cd brand_new_laravel_project

In order to run some migrations doctrine\dbal is needed so you must add it

$ composer require doctrine/dbal

Add Laravel's Jetstream dependency (soon to be replaced)

$ composer require laravel/jetstream
$ php artisan jetstream:install livewire
$ npm install && npm run dev

As this package is currently on development you need Debugbar of barryvdh perhaps there are some missing \DebugBar::info() over there

$ composer require barryvdh/laravel-debugbar --dev

Then you must set-up/create your laravel .env file with all your configs, and with your database conection paramas .

Lets add Orchid:

$ composer require orchid/platform

Important note: as matter of fact, currently there is no compatibility with laravel 9 so orchid/plaform 11.0.1 was the last version suporting laravel 8, so you might need to specify the version on composer command.

$ composer require orchid/platform:11.0.1

Then you must install the platform

$ php artisan orchid:install

We need to change the "true" value by "false" at the auth entry on the config/platform.php config file in order to use jetstream.

//config/platform.php
auth = false; 

Install

Just add kamansoft/klorchid as normal composer package

$ composer require kamansoft/klorchid

Lets set klorchid Kuser model as default model used by auth, so you must change the value of the entry providers.users.model from the default App\Models\User::class to the klorchid one Kamansoft\Klorchid\Models\KlorchidUser::class on the config/auth.php file

//config/auth.php
'providers' => [
   'users' => [
       'driver' => 'eloquent',
       'model' => Kamansoft\Klorchid\Models\KlorchidUser::class,
   ],
   .
   .
   .

Finally we run the klorchid install command

$ php artisan klorchid:install