osinitiative/web-app-boilerplate

Web Application Boilerplate Based on Laravel Framework.

, _(*1)

Laravel Boilerplate

A boilerplate based on Laravel Framework to speed up web application development setup., _(*2)

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:, _(*3)

$ 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., _(*4)

Login details for default users:, _(*5)

1. E-mail : developer@app.com Password: developer
2. E-mail : administrator@app.com Password: administrator
3. E-mail : user@app.com Password: user

By default, all newly registered user will be assign role as user., _(*6)

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., _(*7)

Seeded roles and permissions based on database/seeds/RolesAndPermissionsSeeder.php will have all guards specify in config/auth.php., _(*8)

Commands

There's some commands area ready built-in. Others, may refer to respective packages., _(*9)

• 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., _(*10)

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., _(*11)

Contributions

Contributions are welcome and will be fully credited., _(*12)

We accept contributions via Pull Requests on Github., _(*13)

Pull Requests

• PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer., _(*14)

• Add tests! - Your patch won't be accepted if it doesn't have tests., _(*15)

• Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date., _(*16)

• Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option., _(*17)

• Create feature branches - Don't ask us to pull from your master branch., _(*18)

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

• 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., _(*20)

Running Test

$ vendor/bin/phpunit

License

This package is open-sourced software licensed under the MIT license., _(*21)