Laravel Boilerplate

A boilerplate based on Laravel Framework to speed up web application development setup.

Packages

• Cleanique Coders - Artisan Makers
• Cleanique Coders - Blueprint Macro
• Cleanique Coders - Laravel Helper
• Cleanique Coders - Laravel Observers
• Cleanique Coders - Money Wrapper
• Cleanique Coders - Profile
• Spatie - Image Optimizer
• Spatie - Laravel Activitylog
• Spatie - Laravel Html
• Spatie - Laravel Medialibrary
• Spatie - Laravel Permission
• Spatie - Laravel Responsecache
• Spatie - Laravel Sluggable
• Softon - Sweet Alert
• Tighten.Co - Ziggy

Installation

$ composer create-project cleaniquecoders/laravel-boilerplate

Configure your .env, then:

$ php artisan reload:all -d

Usage

User Accounts

By default, there's no users created. But you can run php artisan db:seed DevelopmentSeeder to run create 3 main users - Developer, Administrator and User.

Login details for default users:

1. E-mail : [email protected] Password: developer
2. E-mail : [email protected] Password: administrator
3. E-mail : [email protected] Password: user

By default, all newly registered user will be assign role as user.

Access Control

Access control for the application can be configure from config/acl.php. It consist of roles, permissions and actions. Default seeder for ACL is in database/seeds/RolesAndPermissionsSeeder.php. You may overwrite this as you please.

Seeded roles and permissions based on database/seeds/RolesAndPermissionsSeeder.php will have all guards specify in config/auth.php.

Commands

There's some commands area ready built-in. Others, may refer to respective packages.

• reload:db - Run migrate:fresh --seed with profile:seed. You may extend the usage.
• reload:cache - Recache everything
• reload:all - Run above two commands. Passing -d will seed DevelopementSeeder - useful for development setup.

Routes

Routes has been organised so that you can manage it properly, keep it clean and well organised.

1. API Routes - routes/api
2. Breadcrumbs Routes - routes/breadcrumbs
3. Datatable Routes - routes/datatable
4. Web Routes - routes/web

You may add unlimited files in respective directories above, based on it's concern.

Contributions

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

• PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

• Add tests! - Your patch won't be accepted if it doesn't have tests.

• Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

• Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

• Create feature branches - Don't ask us to pull from your master branch.

• One pull request per feature - If you want to do more than one thing, send multiple pull requests.

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Running Test

$ vendor/bin/phpunit

License

This package is open-sourced software licensed under the MIT license.