Frontend version: Paper Dashboard v2.1.1. More info at https://www.creative-tim.com/product/paper-dashboard-2/?ref=pdl-readme

Speed up your web development with the Bootstrap 4 Admin Dashboard built for Laravel Framework 5.5 and up.

Note

We recommend installing this preset on a project that you are starting from scratch, otherwise your project’s design might break.

Prerequisites

If you don’t already have an Apache local environment with PHP and MySQL, use one of the following links:

Also, you will need to install Composer: https://getcomposer.org/doc/00-intro.md
And Laravel: https://laravel.com/docs/6.x/installation

Installation

After initializing a fresh instance of Laravel (and making all the necessary configurations), install the preset using one of the provided methods:

Via composer

1. Cd to your Laravel app
2. Install this preset via composer require laravel-frontend-presets/paper-dashboard. No need to register the service provider. Laravel 5.5 & up can auto detect the package.
3. Run php artisan preset paper command to install the Argon preset. This will install all the necessary assets and also the custom auth views, it will also add the auth route in routes/web.php (NOTE: If you run this command several times, be sure to clean up the duplicate Auth entries in routes/web.php)
4. In your terminal run composer dump-autoload
5. Run php artisan migrate --seed to create basic users table

By using the archive

1. In your application’s root create a presets folder
2. Download an archive of the repo and unzip it
3. Copy and paste paper-dashboard-master folder in presets (created in step 2) and rename it to paper
4. Open composer.json file
5. Add "LaravelFrontendPresets\\PaperPreset\\": "presets/paper/src" to autoload/psr-4 and to autoload-dev/psr-4
6. Add LaravelFrontendPresets\PaperPreset\PaperPresetServiceProvider::class, to config/app.php file
7. In your terminal run composer dump-autoload
8. Run php artisan preset paper command to install the Paper Dashboard preset. This will install all the necessary assets and also the custom auth views, it will also add the auth route in routes/web.php (NOTE: If you run this command several times, be sure to clean up the duplicate Auth entries in routes/web.php)
9. Run php artisan migrate --seed to create basic users table

Usage

Register a user or login using admin@paper.com and secret and start testing the preset (make sure to run the migrations and seeders for these credentials to be available).

Besides the dashboard and the auth pages this preset also has a user management example and an edit profile page. All the necessary files (controllers, requests, views) are installed out of the box and all the needed routes are added to routes/web.php. Keep in mind that all of the features can be viewed once you login using the credentials provided above or by registering your own user.

Dashboard

You can access the dashboard either by using the "Dashboard" link in the left sidebar or by adding /home in the url.

Profile edit

You have the option to edit the current logged in user’s profile (change name, email and password). To access this page just click the "User profile" link in the left sidebar or by adding /profile in the url.

The App\Htttp\Controlers\ProfileController handles the update of the user information.

public function update(ProfileRequest $request) { auth()->user()->update($request->all()); return back()->withStatus(__('Profile successfully updated.')); } 

Also you shouldn’t worry about entering wrong data in the inputs when editing the profile, validation rules were added to prevent this (see App\Http\Requests\ProfileRequest). If you try to change the password you will see that other validation rules were added in App\Http\Requests\PasswordRequest. Notice that in this file you have a custom validation rule that can be found in App\Rules\CurrentPasswordCheckRule.

public function rules() { return [ 'old_password' => ['required', 'min:6', new CurrentPasswordCheckRule], 'password' => ['required', 'min:6', 'confirmed', 'different:old_password'], 'password_confirmation' => ['required', 'min:6'], ]; } 

User management

The preset comes with a user management option out of the box. To access this click the "User Management" link in the left sidebar or add /user to the url. The first thing you will see is the listing of the existing users. You can add new ones by clicking the "Add user" button (above the table on the right). On the Add user page you will see the form that allows you to do this. All pages are generate using blade templates:

<div class="row"> <label class="col-sm-2 col-form-label"></label> <div class="col-sm-7"> <div class="form-group"> <input class="form-control" name="name" id="input-name" type="text" placeholder="" value="" required="true" aria-required="true"/> @if ($errors->has('name')) <span id="name-error" class="error text-danger" for="input-name"></span> @endif </div> </div> </div> 

Also validation rules were added so you will know exactely what to enter in the form fields (see App\Http\Requests\UserRequest). Note that these validation rules also apply for the user edit option.

public function rules() { return [ 'name' => [ 'required', 'min:3' ], 'email' => [ 'required', 'email', Rule::unique((new User)->getTable())->ignore($this->route()->user->id ?? null) ], 'password' => [ $this->route()->user ? 'nullable' : 'required', 'confirmed', 'min:6' ] ]; } 

Once you add more users, the list will get bigger and for every user you will have edit and delete options (access these options by clicking the three dotted menu that appears at the end of every line).

All the sample code for the user management can be found in App\Http\Controllers\UserController. See store method example bellow:

public function store(UserRequest $request, User $model) { $model->create($request->merge(['password' => Hash::make($request->get('password'))])->all()); return redirect()->route('user.index')->withStatus(__('User successfully created.')); } 

Table of Contents

Versions

HTML	LARAVEL

Demo

Profile Page	Users Page	Notifications Page
View More

Documentation

The documentation for the Paper Dashboard Laravel is hosted at our website.

File Structure

├── app │   ├── Http │   │   ├── Controllers │   │   │   ├── Auth │   │   │   │   └── RegisterController.php │   │   │   ├── HomeController.php │   │   │   ├── PageController.php │   │   │   ├── ProfileController.php │   │   │   └── UserController.php │   │   └── Requests │   │   ├── PasswordRequest.php │   │   ├── ProfileRequest.php │   │   └── UserRequest.php │   └── Rules │   └── CurrentPasswordCheckRule.php ├── database │   └── seeds │   ├── DatabaseSeeder.php │   └── UsersTableSeeder.php └── resources ├── assets │   ├── css │   │   ├── bootstrap.min.css │   │   ├── bootstrap.min.css.map │   │   ├── paper-dashboard.css │   │   ├── paper-dashboard.css.map │   │   └── paper-dashboard.min.css │   ├── demo │   │   ├── demo.css │   │   └── demo.js │   ├── fonts │   │   ├── nucleo-icons.eot │   │   ├── nucleo-icons.ttf │   │   ├── nucleo-icons.woff │   │   └── nucleo-icons.woff2 │   ├── img │   │   ├── apple-icon.png │   │   ├── bg │   │   │   ├── fabio-mangione.jpg │   │   │   └── jan-sendereks.jpg │   │   ├── bg5.jpg │   │   ├── damir-bosnjak.jpg │   │   ├── default-avatar.png │   │   ├── faces │   │   │   ├── ayo-ogunseinde-1.jpg │   │   │   ├── ayo-ogunseinde-2.jpg │   │   │   ├── clem-onojeghuo-1.jpg │   │   │   ├── clem-onojeghuo-2.jpg │   │   │   ├── clem-onojeghuo-3.jpg │   │   │   ├── clem-onojeghuo-4.jpg │   │   │   ├── erik-lucatero-1.jpg │   │   │   ├── erik-lucatero-2.jpg │   │   │   ├── joe-gardner-1.jpg │   │   │   ├── joe-gardner-2.jpg │   │   │   ├── kaci-baum-1.jpg │   │   │   └── kaci-baum-2.jpg │   │   ├── favicon.png │   │   ├── header.jpg │   │   ├── jan-sendereks.jpg │   │   ├── logo-small.png │   │   └── mike.jpg │   ├── js │   │   ├── core │   │   │   ├── bootstrap.min.js │   │   │   ├── jquery.min.js │   │   │   └── popper.min.js │   │   ├── paper-dashboard.js │   │   ├── paper-dashboard.js.map │   │   ├── paper-dashboard.min.js │   │   └── plugins │   │   ├── bootstrap-notify.js │   │   ├── chartjs.min.js │   │   └── perfect-scrollbar.jquery.min.js │   └── scss │   ├── paper-dashboard │   │   ├── _alerts.scss │   │   ├── _animated-buttons.scss │   │   ├── _buttons.scss │   │   ├── cards │   │   │   ├── _card-chart.scss │   │   │   ├── _card-map.scss │   │   │   ├── _card-plain.scss │   │   │   ├── _card-stats.scss │   │   │   └── _card-user.scss │   │   ├── _cards.scss │   │   ├── _checkboxes-radio.scss │   │   ├── _dropdown.scss │   │   ├── _fixed-plugin.scss │   │   ├── _footers.scss │   │   ├── _images.scss │   │   ├── _inputs.scss │   │   ├── _misc.scss │   │   ├── mixins │   │   │   ├── _buttons.scss │   │   │   ├── _cards.scss │   │   │   ├── _dropdown.scss │   │   │   ├── _inputs.scss │   │   │   ├── _page-header.scss │   │   │   ├── _transparency.scss │   │   │   └── _vendor-prefixes.scss │   │   ├── _mixins.scss │   │   ├── _navbar.scss │   │   ├── _nucleo-outline.scss │   │   ├── _page-header.scss │   │   ├── plugins │   │   │   ├── _plugin-animate-bootstrap-notify.scss │   │   │   └── _plugin-perfect-scrollbar.scss │   │   ├── _responsive.scss │   │   ├── _sections.scss │   │   ├── _sidebar-and-main-panel.scss │   │   ├── _tables.scss │   │   ├── _typography.scss │   │   └── _variables.scss │   └── paper-dashboard.scss └── views ├── auth │   ├── login.blade.php │   ├── passwords │   │   ├── email.blade.php │   │   └── reset.blade.php │   └── register.blade.php ├── layouts │   ├── app.blade.php │   ├── footer.blade.php │   ├── navbars │   │   ├── auth.blade.php │   │   └── navs │   │   ├── auth.blade.php │   │   └── guest.blade.php │   └── page_templates │   ├── auth.blade.php │   └── guest.blade.php ├── pages │   ├── dashboard.blade.php │   ├── icons.blade.php │   ├── map.blade.php │   ├── notifications.blade.php │   ├── tables.blade.php │   ├── typography.blade.php │   └── upgrade.blade.php ├── profile │   └── edit.blade.php ├── users │   ├── create.blade.php │   ├── edit.blade.php │   └── index.blade.php └── welcome.blade.php 

Browser Support

At present, we officially aim to support the last two versions of the following browsers:

Resources

HTML	LARAVEL

Change log

Please see the changelog for more information on what has changed recently.

Credits

Reporting Issues

We use GitHub Issues as the official bug tracker for the Paper Dashboard Laravel. Here are some advices for our users that want to report an issue:

1. Make sure that you are using the latest version of the Paper Dashboard Laravel. Check the CHANGELOG from your dashboard on our website.
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

Licensing

Useful Links

Social Media

Creative Tim:

Twitter: https://twitter.com/CreativeTim?ref=pdl-readme

Facebook: https://www.facebook.com/CreativeTim?ref=pdl-readme

Dribbble: https://dribbble.com/creativetim?ref=pdl-readme

Instagram: https://www.instagram.com/CreativeTimOfficial?ref=pdl-readme

Updivision:

Twitter: https://twitter.com/updivision?ref=pdl-readme

Facebook: https://www.facebook.com/updivision?ref=pdl-readme

Linkedin: https://www.linkedin.com/company/updivision?ref=pdl-readme

Updivision Blog: https://updivision.com/blog/?ref=pdl-readme

Credits

Laravel Cloud Pub/Sub.

Why?

Build a scalable Laravel apps using event-driven microservices architecture (Pub/Sub), this tool adds the ability for your Laravel applications to communicate with each other using Google Cloud Pub/Sub.

Define your architecture.

First of all, you need to create subscriptions and topics in Google Cloud Platform, or you can use the cli.

Installation.

• composer require gdg-tangier/cloud-pubsub

Configuration.

You can define multiple subscribers (queue connections) config in config/queue.php, the app can subscribe to multiple subscriptions.

Example.

'pubsub' => [  'driver' => 'pubsub',  'queue' => env('SUBSCRIPTION'),  'credentials' => [  'keyFilePath' => storage_path(env('PUBSUB_CLIENT_KEY')), // credentials file path '.json'  'projectId' => env('GCP_PROJECT_ID'),  ],  ],

Here where you can define your subscriptions jobs, events and topics mappings.

Example.

<?php  return [  /*  * GCP Credentials.  */  'credentials' => [  'keyFilePath' => storage_path(env('PUBSUB_CLIENT_KEY', 'client')),  'projectId' => env('GCP_PROJECT_ID'),  ],   /*  * Here where you map events name with Google Pub/Sub topics.  *  * Means, map each event name to specific Google Pub/Sub topic.  */  'events' => [  'event_name' => '__YOUR_TOPIC_NAME__',  ],   /*  * Here where you can tie the subscription classes (jobs) to topics.  *  * Means, map each subscription job to a specific Google pubsub topic.  * The subscription job is responsible for handling the incoming data  * from a Google Pub/Sub topic.  */  'subscriptions' => [  \App\PubSub\DummyJob::class => '__YOUR_TOPIC_NAME__',  ], ];

Create subscription class.

• php artisan pubsub:make-subscriber <Name>

A subscription class will be created at app/Subscribers

Example.

<?php  namespace App\Subscribers;  use GDGTangier\PubSub\Subscriber\SubscriberJob; use GDGTangier\PubSub\Subscriber\Traits\JobHandler;  class UserUpdated {  use JobHandler;   /**  * @var mixed  */  public $payload;   /**  * @var \GDGTangier\PubSub\Subscriber\SubscriberJob  */  public $job;   /**  * UserUpdated constructor.  *  * @param \GDGTangier\PubSub\Subscriber\SubscriberJob $job  * @param $payload  */  public function __construct(SubscriberJob $job, $payload)  {  $this->job = $job;  $this->payload = $payload;  }   /**  * Execute the job.  *  * @return void  */  public function handle()  {  //   } }

Publishing data to the cloud.

use GDGTangier\PubSub\Publisher\Facades\PublisherFacade;  PublisherFacede::publish('MyData', 'event_name');

$publisher = app('gcloud.publisher.connection');  $publisher->publish('MyDaya', 'event_name');

php artisan pubsub:publish <message> <event>

Subscriptions worker.

• php artisan pubsub:subscribe <connection>

Note: To keep the queue:subscribe process running permanently in the background, you should use a process monitor such as Supervisor to ensure that the queue worker does not stop running.

Testing.

You need to install GCP command line tool.

1. Run the pubsub emulator./emulator.sh
2. Export the pubsub emulator host export PUBSUB_EMULATOR_HOST=localhost:8085
3. Run phpunit