README

About this project

The Blackbird Project is intended to be a starting point for other projects based on the Laravel framework. Containing in this boilerplate several packages that can aid and accelerate the construction of your web projects.

Laravel Environment

PHP Version: ^7.2
Laravel Version: 6.*
Timezone: America/Sao_Paulo
Locale: pt_BR
Database: MySQL - Version: 5.7.27-0ubuntu0.18.04.1

Third-party Packages included

arcanedev/log-viewer: ^5.1
arcanedev/route-viewer: ^2.1
arrilot/laravel-widgets: ^3.13
creativeorange/gravatar: ^1.0
davejamesmiller/laravel-breadcrumbs: ^5.3
jeroennoten/laravel-adminlte: ^3.0
laravel/envoy: ^1.6
laravel/socialite: ^4.3
realrashid/sweet-alert: ^3.0
spatie/laravel-backup: ^6.7
spatie/laravel-medialibrary: ^7.14
spatie/laravel-sluggable: ^2.2
unsplash/unsplash: ^2.5
yajra/laravel-datatables-oracle: ^9.7

Third-party Packages for Development Mode included

barryvdh/laravel-ide-helper: ^2.6
deployer/deployer: ^6.6
laravel/ui: ^1.1
matt-allan/laravel-code-style: ^0.4.0

Cloning this project

To use this project, you must type the following line in your command terminal

git clone https://github.com/fsclaro/blackbird.git

You will need a mysql server installed e configured, then execute the command below to create a database for the your project.

mysql -e 'create database <YOUR_DATABASE_NAME>;' -u <YOUR_MYSQL_USERNAME> -p

Edit the .env file to modify the parameters below, according your database environment

DB_DATABASE=<YOUR_DATABASE_NAME>
DB_USERNAME=<YOUR_MYSQL_USERNAME>
DB_PASSWORD=<PASSWORD_OF_YOUR_MYSQL_USERNAME>

The default values are

DB_DATABASE=blackbird
DB_USERNAME=homestead
DB_PASSWORD=secret

After, run commands bellow in terminal:

composer install
php artisan key:generate
php artisan migrate
php artisan db:seed
php artisan storage:link

Defaults Login Users

This boilerplate have two defaults users

User	Login	Password
Admin	admin@blackbird.test	password
User	user@blackbird.test	password

New composer commands

1) composer clear-all, execute:

artisan clear-compiled
artisan cache:clear
artisan route:clear
artisan view:clear
artisan config:clear
composer dumpautoload -o

2) composer cache-all, execute:

artisan config:cache
artisan route:cache

3) composer ide-helper, execute:

artisan ide-helper:generate
artisan ide-helpder:meta

4) composer format, execute:

php-cs-fixer fix app/ --show-progress=estimating
php-cs-fixer fix config/ --show-progress=estimating
php-cs-fixer fix database/ --show-progress=estimating
php-cs-fixer fix resources/ --show-progress=estimating
php-cs-fixer fix routes/ --show-progress=estimating
php-cs-fixer fix tests/ --show-progress=estimating

Internalization

This project is configured for the Brazilian Portuguese Language with the timezone configured for America/Sao_Paulo, locale for pt-br and faker_locale for pt_BR. If you are of another nationality, simply edit the config/app.php file and customize the timezone and locale parameters according to your need.

Contributing

Thank you for considering contributing to the blackbird Project! If you have good ideas to make this project better, read the contribution guidelines on contributions and send me an email to fsclaro@gmail.com

Code of Conduct

It is very important that you read our code of conduct so that there is a healthy coexistence among all members participating in this project.

Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to Fernando Salles Claro at fsclaro@gmail.com. All security vulnerabilities will be promptly addressed.

License

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

Credits

The background images at Unplash by authors/photographers:

fsclaro/blackbird

Maintainers

Details