adifaidz/base

Laravel wrapper for frequently used package

Base

Laravel wrapper for commonly used package and crud generators for basic crud functionalities, _(*1)

Before you start, read this

• This package, _(*2)

  • Is a Laravel (Currently 5.4) package, _(*3)

  • Is still under heavy development :loudspeaker: :construction:, _(*4)

  • Uses mainly Laravel, Vue, Bootstrap and Laravel-Mix, _(*5)

  • Affects some settings on installation :warning:, _(*6)

  • Uses these npm packages:, _(*7)

  • admin-lte : ^2.3.8, _(*8)

  • axios: ^0.15.2
  • babel-plugin-transform-runtime: ^6.23.0
  • babel-preset-stage-2: ^6.22.0
  • bootstrap-sass: ^3.3.7
  • eonasdan-bootstrap-datetimepicker: ^4.17.43
  • font-awesome: ^4.7.0
  • jquery: ^3.1.0
  • laravel-mix: ^0.8.4
  • lodash: ^4.17.4
  • toastr: ^2.1.2
  • vue: ^2.0.1
  • vue-multiselect: 2.0.0-beta.13
  • vue-resource: ^1.0.3
  • vuetable-2: ^0.9.2

Features

• Ready to use base functionalities (user profile, login, acl, etc ), _(*9)

• Create crud components (views, controller, routes) based on eloquent model, _(*10)

• Debug using phpdebugbar and logviewer based on your environment, _(*11)

• Clean project using clean, _(*12)

• Easily create menus with laravel-menu, _(*13)

Installation

• Install using composer, _(*14)

  composer require adifaidz/base
  

• Register the service provider to your providers array in config/app.php, _(*15)

  AdiFaidz\Base\Providers\BaseServiceProvider::class,
  

• Run the install command using artisan, this will register guards, providers, password broker, route middlewares and middleware groups. It will also publish vue components, assets and bundling scripts and create route files., _(*16)

  php artisan base:install
  

• Add this to the boot method in app\Providers\AppServiceProvider.php to register all package routes, _(*17)

  use AdiFaidz\Base\Base;
  
  ...
  
  Base::routes();
  

• Change the auth users provider model in config/auth.php to, _(*18)

  'users' => [
      'driver' => 'eloquent',
      'model' => AdiFaidz\Base\BaseUser::class,
  ],
  

• Then, replace the current ExceptionHandler in bootstrap/app.php with Base ExceptionHandler class., _(*19)

  $app->singleton(
      Illuminate\Contracts\Debug\ExceptionHandler::class,
      AdiFaidz\Base\Exceptions\Handler::class
  );
  

• After that, add this to the map method in app\Providers\RouteServiceProvider.php for generated package routes, _(*20)

  use AdiFaidz\Base\Base;
  
  ...
  
  Base::mapBaseRoutes();
  

• Then, configure your database connection and run migrate. Upon completion, tables for users, roles, permissions will be created, _(*21)

  php artisan migrate
  

• Seed the tables, _(*22)

  php artisan db:seed --class="AdiFaidz\Base\Seeders\StartupSeeder"
  

• And finally, run, _(*23)

  npm install && npm run watch
  
  or
  
  npm install && npm run dev
  

• Start up your server and go to, _(*24)

  http://localhost/login
  

Todo :computer: :watch:

• Create form and detail view based on model attributes, _(*25)

• Fallback to [mailtrap][9] in development environment, _(*26)

• Detailed documentation, _(*27)

• Provide better flow, _(*28)