lexxsoft/upbasis

Universal Platform basis

dev-master 2023-04-06 15:49 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-zip: *
• symfony/yaml: ^6.2

Requires (Dev)

• laravel/framework: ^10.5
• nwidart/laravel-modules: ^10.0

MIT

• Aleksey Komov

• library
• command
• artisan
• basis
• Up
• universal platform

README

This package provide startup functionality to manage Universal Platform

Installation

Install package via composer command

composer require lexxsoft/upbasis

Initialization

To prepare Laravel project for using and developing with Universal Platform, you can run command

php artisan up:init

This command will install required composer packages, updates composer PSR4 section, update laravel configurations, create resource files.

This command completely overwrite:

• /app/Http/Kernel.php
• app/Providers/AuthServiceProvider.php
• routes/web.php
• config/cors.php
• vite.config.js
• /resource

of your project.

Next packages will be installed

• laravel/sanctum
• nwidart/laravel-modules
• spatie/laravel-permission

For all packages will be called command php artisan vendor:publish

Run database migration to create necessary tables

php artisan migrate

Finally, publish configuration file

php artisan vendor:publish --provider="Lexxsoft\Upbasis\UpBasisServiceProvider" --tag="config"

Now your project have all required packages and resources for developing interfaces on VueJS and typescript.

Requirements

This package use nwidart/laravel-modules package as main functionality to separate platform on modules. You should install in via command

composer require nwidart/laravel-modules

Force creation and overrides

Temporary file storage

Current package add to filesystems.disks configuration of tmp disc, if it does not exist. tmp disc has next configuration:

'driver' => 'local',
'root' => storage_path('tmp'),
'throw' => false,

This disk used for temporary created files and don't contain any important data.

Module activators

By default nwidart/laravel-modules module activator is file. Universal Platform basis package forcefully create activator with identifier up_database with next credentials:

'class' => \Lexxsoft\Upbasis\Support\DatabaseModuleActivator::class,
'cache-key' => 'activator.installed',
'cache-lifetime' => 5184000,

Next, current package set up_database activator as default module activator. This provides single correct module activator for using Universal Platform.

Provided module activator use laravel cache system

Provided artisan commands

Generate templates based on model

php artisan up:generate {module} {model} {--vers=V1}

This will generate next files:

• CreateRequest
• UpdateRequest
• DefaultRulesRequest
• Resource
• Controller
• Factory
• Seeder This generator use model $fillable property.

Fill model $fillable property by certain fields. Otherwise, generation result will be unacceptable.

Options:

Param/Option	Short	Required	Default	Description
module		Yes		Module name
model		Yes		Model name
--vers			V1	API version (*)

(*) API version affect to package name of

• CreateRequest
• UpdateRequest
• DefaultRulesRequest
• Resource

Install module from external repository

php artisan up:require {module} {--M|no-migration} {--T|no-translation} {--P|no-permission} {--A|no-activate} {--S|skip-server-installation} {--C|skip-client-installation} {--b|backup-exist} {--f|force}

Command will download and register module of Universal Platform.

It will download file from external storage.

Options:

Param/Option	Short	Required	Default	Description
module		Yes		Module name
--no-migration	-M			Do not run migration
--no-translation	-T			Do not import translation
--no-permission	-P			Do not import permissions
--no-activate	-A			Do not activate module
--skip-server-installation	-S			Skip server installation part
--skip-client-installation	-C			Skip client installation part
--backup-exist	-b			Backup existed file
--force	-f			Forcefully rewrite module directory

Extract module

php artisan up:extract {module}

This will collect all module files, permissions and translations in separate .zip file.

Options:

Param/Option	Short	Required	Default	Description
module		Yes		Module name