Setup a Laravel Admin Dashboard With InfyOm in Few Minutes, Even on Existing Projects

Kalizi <Andrea>
Dec 10, 2020 · 8 min read
Photo by Carlos Muza on Unsplash

You’ve spent the latest X hours building a very complex system, with lots of complex interactions and features, you wrote tests and now everything works. But you haven’t a Dashboard where you can monitor details of your system and perform CRUD operations on your system models, and you don’t want to spend much time spinning up a dashboard that you don’t directly need or won’t directly use, so?

This is, in shorts, what happened to me some days ago. I want to give you a background without biasing your view on the entire idea of this blog post.
I had to build a complex system where you can perform just one operation, the system has just one complex feature: the user must upload files, pick a configuration, insert his email (yes, the user has no logins) and then give everything to the server that enqueues a job; this job works in the background performing the stuff it has to do and finally sends an email. It was a beautiful system to code (if you like coding 💻 like me), I had to glue Laravel with some bash scripts, I wrote tests, checked for security faults, but… what about if the managers want to see the current status of the jobs and what users do? And I started looking for the fastest way to build a nice dashboard with CRUD operations, with the fewer code to write and the best possible result, and here it is InfyOmLabs Laravel Generator!

🔧 Setup everything

I’ll start from an existing project, but everything here can be replicated easily in every project even a new one.

As said before, in my project I don’t have any user model (because I have no login), so I’ll start from its migration. You can safely take the laravel built-in migration, and programmatically create a user via tinker or in some other way, I’ll put tinker code:

Now we’re ready to build the dashboard with the generator, we need to start from composer.json :

With these packages, you’ll add the generator, HTML generator, adminlte-template for the dashboard, dbal to read schemas from the database and use for generation, yajra datatables packages for jQuery datatables generation and server interactions made easy. If you prefer, you can switch the template to CoreUI using "infyomlabs/coreui-templates": "8.0.x-dev" (instead of the adminlte). Now just composer update .

Now publish config php artisan vendor:publish --provider="InfyOm\Generator\InfyOmGeneratorServiceProvider" and we’re ready to go!

Now tweak config/infyom/laravel_generator.php by editing:

  1. path: if you want to put every generated content into a specific folder, in my case I wanted everything to be under an admin folder, so I appended /admin as the folder where needed (views). This is particularly helpful if you want to separate admin stuff from your system code.
  2. 'templates' => 'your_template_here': you can put adminlte-templates or coreui-templates.
  3. 'repository_pattern' => false in the options key, I don’t like repository so much, but you can keep it if you prefer
  4. 'prefixes' => [ 'route' => 'admin', 'path' => 'admin', 'views' => '', 'public' => '' ] this will add every route as admin.? in the path /admin.
  5. 'datatables' => true if you want to enable datatables, personally I love them.
  6. 'tests' => false it’s a generator and I won’t perform any particular editing on generated files, so I don’t really need tests (it’s on you).

Last but not least, we have to publish infyom default files for the generation with php artisan infyom:publish and with php artisan infyom.publish:layout (this last command will generate views even for authentication, if you already have, will prompt for overwriting). If you want to use datatables (with server-side rendering), you also have to publish datatables stuff by running php artisan vendor:publish --tag='datatables-button'.

Now we’re ready to go!

✏️ Our first CRUD️

Photo by Galymzhan Abdugalimov on Unsplash

InfyOm is ready and now we can generate our CRUD via artisan, how? Let’s see what commands we can perform by running php artisan:

We have lots of commands we can run, and every command has lots of options. I don’t need everything so I’ll concentrate on the scaffold command and we’ll deep into its options by running php artisan infyom:scaffold --help (I will omit laravel default options like --help or -v|vv|vvv and focus just on the generator options)

Usage:
infyom:scaffold [options] [--] <model>
Arguments:
model Singular Model name
Options:
--fieldsFile=FIELDSFILE Fields input as json file
--jsonFromGUI=JSONFROMGUI Direct Json string while using GUI interface
--plural=PLURAL Plural Model name
--tableName=TABLENAME Table Name
--fromTable Generate from existing table
--ignoreFields=IGNOREFIELDS Ignore fields while generating from table
--save Save model schema to file
--primary=PRIMARY Custom primary key
--prefix=PREFIX Prefix for all files
--paginate=PAGINATE Pagination for index.blade.php
--skip=SKIP Skip Specific Items to Generate (migration,model,controllers,api_controller,scaffold_controller,repository,requests,api_requests,scaffold_requests,routes,api_routes,scaffold_routes,views,tests,menu,dump-autoload)
--datatables=DATATABLES Override datatables settings
--views=VIEWS Specify only the views you want generated: index,create,edit,show
--relations Specify if you want to pass relationships for fields
--softDelete Soft Delete Option
--forceMigrate Specify if you want to run migration or not
--factory To generate factory
--seeder To generate seeder
--localized Localize files.
--repositoryPattern=REPOSITORYPATTERN Repository Pattern
--connection=CONNECTION Specify connection name

As you can see, there’s a lot of options you can tweak and exploit to get a CRUD as fast as you can.

Now you have to focus on your database, my model name is ProcessingSession (table name: processing_sessions) that has a one-to-many relationship with ProcessingFile (table name: processing_files). The command I used to set up the first CRUD is:

Take a look at every option:

  • --fromTable --tableName=processing_sessions these options are needed to get model data from the database. By using dbal, this will fetch the table structure from the database and use every detail about the table structure for the generation.
  • --factory will generate a factory for the model.
  • --seeder will generate a seeder for the model.
  • --skip=model this is needed if you already have your own model implementation, if you don’t have any model in your project, this will generate a Model file for your table.

The output will be something like:

Seeder created:
ProcessingSessionsTableSeeder.php
Create Request created:
CreateProcessingSessionRequest.php
Update Request created:
UpdateProcessingSessionRequest.php
DataTable created:
ProcessingSessionDataTable.php
Controller created:
ProcessingSessionController.php
Generating Views...
datatables_actions.blade.php created
table.blade.php created
index.blade.php created
field.blade.php created
create.blade.php created
edit.blade.php created
show_fields.blade.php created
show.blade.php created

Views created.
processingSessions routes added.processingSessions menu added.Schema File saved:
ProcessingSession.json
Generating autoload files

What happened after this command? Lookup at file changes:

app/Http/Controllers/Admin/ProcessingSessionController.php
app/Http/Requests/Admin/CreateProcessingSessionRequest.php
app/Http/Requests/Admin/UpdateProcessingSessionRequest.php
database/factories/ProcessingSessionFactory.php
database/seeders/ProcessingSessionTableSeeder.php
resources/views/admin/processing_sessions/*.blade.php
Changed:routes/web.php

InfyOm just publishes stuff, doesn’t add user checking, so we have to build a Middleware php artisan make:middleware AdminMiddleware and add any logic you want.

Now open routes/web.php, fix the Controller generated (if it doesn’t work) and add the middleware:

We still need two tweaks, open the Controller, the Requests and the DataTable and fix your model imports from App\Models\Admin\Model to App\Models\Model or to whichever is your model namespace. The other is to add validation rules in your model as a static property. If you look at your request classes you can see that in the rules() methods InfyOm uses the static property Model::$rules that you must add to your model.

And we’re ready to go, if authentication works, you can open admin/processingSessions and here’s the CRUD!

Basic CRUD built with InfyOm, ready for customization

Every other crud will be kinda the same. Every time you generate a CRUD you’ll have the following files:

If you want to edit any step of the CRUD process, you’ll have to edit the relative file (if you want to show relations you can edit the show.blade.php putting their models by injecting from the controller, if you use Eloquent default relations you can do it easily).
Please note: the fields.blade.php file is shared between the Create and the Update steps, it uses the Form facade that will automatically inject the model. While in Create step the model isn’t defined, so if you edit the file pay attention to don’t mess up by using the model instance without that it’s set and initialized using a simple isset($modelName).

🧱 Building a dashboard

Your adminlte template is already setup, you just have to build a view to exploit it. Start with a view in views/admin/index.php that extends views/layouts/app.blade.php and overrides the section content.
After that, build a Controller to handle it php artisan make:controller Admin\DashboardController with an index function that renders the previous view, to link to a route under the group we’ve previously created.

Route::group(
[
'prefix' => 'admin',
'as' => 'admin.',
'middleware' => \App\Http\Middleware\AdminMiddleware::class
],
function () {
Route::get('/', [DashboardController::class, 'index'])->name('index');
// ... your other CRUDs
}
);

You should see an empty dashboard:

Building your dashboard

We want to tweak a few stuff, open views/layouts/app.blade.php, edit the the “InfyOm logo” with yours and with the basic admin URL

Scroll to the footer and edit the “Copyright” section

Everything you have to do now is to compose your dashboard using AdminLTE components from the official documentation, Laravel and Blade Components.

🧠Do you want more?

Check AdminLTE Dependencies and import plugins in your views/layouts/app.blade.php. Do you want to be even faster? You can check other helper packages like this helper for Chart.js. Everything you have to do is to exploit the power of Laravel in combination with this generator!

And that’s all! ✌🏻

The Startup

Get smarter at building your thing. Join The Startup’s +724K followers.

Kalizi <Andrea>

Written by

IT Engineering Bachelor and still student 🎓 Mobile&Backend Dev 💻 Growth hacking Enthusiast ☕ Startupper 🚀 Metalhead 🤘🏻 With love, from Palermo ❤️

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +724K followers.

Kalizi <Andrea>

Written by

IT Engineering Bachelor and still student 🎓 Mobile&Backend Dev 💻 Growth hacking Enthusiast ☕ Startupper 🚀 Metalhead 🤘🏻 With love, from Palermo ❤️

The Startup

Get smarter at building your thing. Follow to join The Startup’s +8 million monthly readers & +724K followers.

Medium is an open platform where 170 million readers come to find insightful and dynamic thinking. Here, expert and undiscovered voices alike dive into the heart of any topic and bring new ideas to the surface. Learn more

Follow the writers, publications, and topics that matter to you, and you’ll see them on your homepage and in your inbox. Explore

If you have a story to tell, knowledge to share, or a perspective to offer — welcome home. It’s easy and free to post your thinking on any topic. Write on Medium

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store