The Laravel package to provide core functionalities for a beautiful Laravel dashboard
Laravue provides necessary Element UI and rich features for an enterprise admin dashboard, therefore it's highly recommended to use for starting a project. The following instructions are for intergrating core features of Laravue to existing Laravel project or to experiement with it.
Install laravue-core package with
composer require tuandm/laravue-core
1.a Setup Laravue with all-in-one command
php artisan laravue:setup
This command will do these steps:
- Setup JWT secret and API endpoint
- Publish Laravue vendor packages/assets
- Install NPM dependencies
- Create .babelc file (if it doesn't exist)
- Setup webpack.mix.js (please backup this file to make sure the current setting will not be lost)
1.b Manual setup
It's recommended to use laravue:setup command. If you want to manually install, you can do following setps:
Generate JWT secret for authentication
php artisan jwt:secret
Add these two lines to
Publish vendor packages/assets
php artisan vendor:publish --provider="Tuandm\Laravue\ServiceProvider" --tag="laravue-core" php artisan vendor:publish --provider="Tuandm\Laravue\ServiceProvider" --tag="laravue-asset"
Add NPM dependencies
npm add babel-plugin-syntax-dynamic-import babel-plugin-syntax-jsx babel-plugin-transform-vue-jsx eslint eslint-loader eslint-plugin-vue laravel-mix-eslint vue-template-compiler svg-sprite-loader --save-dev npm add element-ui js-cookie normalize.css nprogress vuex vue-count-to vue-i18n vue-router npm install # To make sure everything is set
Please check package.json sample
We need to modify the webpack.mix.js to work with Laravue package, please refer to webpack.mix.js sample
Or simply run this command to generate recommendation version.
php artisan laravue:webpack
Laravue requires babel to build the packages. Usually,
.babelrc will be generated with laravue:setup command. Please manual add required plugins to
.babelrc file if your project already uses it. Sample
.babelrc can be found here
2. Config API guard
config/auth.php and modify as below
# Change default auth guard to api 'defaults' => [ 'guard' => 'api', ], ... # Use JWT driver for api guard 'guards' => [ .... 'api' => [ 'driver' => 'jwt', .... # Use Laravue User model to authenticate 'providers' => [ 'users' => [ 'driver' => 'eloquent', 'model' => Tuandm\Laravue\User::class, ],
Please refer to auth.php sample
Laravue core requires
users.role field, consider to run migration if neccessary
php artisan migrate
4. Sample data
This database seeder will insert 3 test users, you can ignore this step if you have data already.
php artisan db:seed --class=Tuandm\\Laravue\\Database\\Seeds\\DatabaseSeeder
npm run dev # or npm run watch
npm run production
Running the tests
- Tests system is under development.
- Laravel - The PHP Framework For Web Artisans
- Element - A Vue 2.0 based component library for developers, designers and product managers
- Vue Admin Template - A minimal vue admin template with Element UI
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Tuan Duong - Initial work - tuandm
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details