Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atnic/laravel-paper-dashboard
https://github.com/atnic/laravel-paper-dashboard
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/atnic/laravel-paper-dashboard
- Owner: Atnic
- Created: 2018-06-21T08:22:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-21T09:01:04.000Z (over 6 years ago)
- Last Synced: 2024-05-06T22:01:53.669Z (8 months ago)
- Language: CSS
- Size: 1.46 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Laravel Paper Dashboard
Laravel Package for integrating Paper Dashboard template and this package is Laravel Mix friendly. Currently this package can be integrated easily only on fresh installation.
# Installation
```bash
composer require atnic/laravel-paper-dashboard
```
If you are using Laravel 5.5 above skip this step. Add this line on ```config/app.php```, on ```providers```
```php
'providers' => [
...
Atnic\PaperDashboard\Providers\AppServiceProvider::class,
...
]
```
And then run,
```bash
php artisan make:paper-dashboard
```
Let's see what we've install. First, make sure that you already ran ```php artisan migrate``` command, then do
```bash
php artisan serve
```
Viola! You've running a Laravel site using Paper Dashboard.
For more information on command
```bash
php artisan make:paper-dashboard --help
```
# Usage
This package provides view for auth and app. Take a look at ```resources/views/layouts/app.blade.php```.
In this file you can extends global section like menu.
To extends menu add this in ```app.blade.php```
```blade
@section('sidebar-menu')
@endsection
```
This package give you free of choice to use any Laravel Package for Menu. We recommend [spatie/laravel-menu](https://github.com/spatie/laravel-menu) or [lavary/laravel-menu](https://github.com/lavary/laravel-menu).
Any new created page should extends this view.
```blade
@extends('layouts.app')
// Your blade here
```
# Configuration and Views Customization
## Config
To publish this package config to your app config run
```bash
php artisan vendor:publish --provider="Atnic\PaperDashboard\Providers\AppServiceProvider" --tag="config"
```
## Views
To publish this package views so you can customize on your own run
```bash
php artisan vendor:publish --provider="Atnic\PaperDashboard\Providers\AppServiceProvider" --tag="views"
```
# Next Step
First of all, you should understand how to use [Laravel Mix](https://laravel.com/docs/5.5/mix).
Paper Dashboard need some package on npm. First you need to run
```bash
npm install
```
Install Paper Dashboard needed package from npm
```bash
npm install --save-dev bootstrap bootstrap-notify bootstrap-sass font-awesome popper.js perfect-scrollbar
```
Run Laravel Mix command
```bash
npm run development
```
or use ```production``` minimize output
```bash
npm run production
```
Then have a good look on these files
- ```webpack.mix.js```
- ```resources/assets/js/paper-dashboard.js```
- ```resources/assets/js/auth.js```
- ```resources/assets/sass/paper-dashboard.scss```
- ```resources/assets/sass/auth.scss```
Happy experimenting!