Please help me by trialing out my package and providing feedback
This package is design to help with asset management and front-end workflow when developing in Laravel 4.
The package can do the following:
- compile and minify CSS
- compile and minify JavaScript
- compile LESS
- compile SASS
- compile Stylus
- build all asset group with one command
- Live reload (watches asset files for changes and reloads the browser)
- ** NOW include support for bower! **
To install the 'Laravel 4 + Grunt Asset Workflow Package' simply add the following to your composer.json "require-dev" array:
"jason-morton-nz/laravel-grunt": "dev-master"
Then run composer update --dev in your terminal.
Next, add the following line to the end of you app/config.php "providers array":
'JasonNZ\LaravelGrunt\LaravelGruntServiceProvider',
Finally, run the following command to add the configuration file to your app/config/packages directory:
php artisan config:publish jason-morton-nz/laravel-grunt
or
php artisan grunt:config
You can configure many of the settings for this package, by traversing to it's configuration file. This file is located in you project's vendor directory, as below:
`app/config/packages/jason-morton-nz/laravel-grunt/config.php`
This file is heavily commented, so hopefully each setting should be self explanatory.
Note: please try not to edit the package.json and grunfile.js directly. Instead make your required changes in the config.php file, then run php artisan grunt:setup to apply the changes.
So, how do you use this package? Well we've tried to make it as simple as possible. There's just 3 commands:
The grunt:setup command is used to setup your required asset + grunt workflow. You use the command as follows:
php artisan grunt:setup
The command will ask you a selection of questions, and the rest is all done for you.
The grunt:build command will run the grunt task runner and lint, compile, minify all your files, according to how you want things done. You use the command as follows:
php artisan grunt:build
The grunt:watch command is used to start a the grunt file watcher. This will watch for any changes made to your front-end workflow files (CSS, JavaScript, LESS, SASS & Stylus), and will then auto-reload your web browser to reflect those changes. You can use the command as follows:
php artisan grunt:watch
Note: That live reload will only work if you have a compatible browser (Chrome & Firefox) with the LiveReload plugin installed.
The bower:setup command will setup bower.json and .bowerrc files based upon the configuration settings you've specified in this packages config.php file. You can add a custom path for bowers vendor folder, as well as stipulate all the bower dependencies you require. All this can be done without touching a single line of JavaScript or JSON. You can use the command as follows:
php artisan bower:setup
The bower:install command is used to install you bower dependencies. You can use the command as follows:
php artisan bower:install
The bower:update command update your bower dependencies to newer versions if available. You can use the command as follows:
php artisan bower:update
If you find any bugs, issues errors or believe we could add further useful functionality. Let us know via the github issues page for this project here - https://github.com/JasonMortonNZ/laravel-grunt/issues.
Here's a list of people who have helped by contributing to this project to date:
- Jason Morton : Github | Twitter @JasonMortonNZ
- Thomas Clarkson : Github | Twitter @thomasclarkson9