Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fsclaro/blackbird

A Brazilian open-source project for a boilerplate for Laravel projects.
https://github.com/fsclaro/blackbird

boilerplate brazilian laravel laravel6 open-source php7 project

Last synced: 3 months ago
JSON representation

A Brazilian open-source project for a boilerplate for Laravel projects.

Awesome Lists containing this project

README

        



[![Latest Stable Version](https://poser.pugx.org/fsclaro/blackbird/v/stable)](https://packagist.org/packages/fsclaro/blackbird)
[![Total Downloads](https://poser.pugx.org/fsclaro/blackbird/downloads)](https://packagist.org/packages/fsclaro/blackbird)
[![Latest Unstable Version](https://poser.pugx.org/fsclaro/blackbird/v/unstable)](https://packagist.org/packages/fsclaro/blackbird)
[![Monthly Downloads](https://poser.pugx.org/fsclaro/blackbird/d/monthly)](https://packagist.org/packages/fsclaro/blackbird)
[![Daily Downloads](https://poser.pugx.org/fsclaro/blackbird/d/daily)](https://packagist.org/packages/fsclaro/blackbird)
[![License](https://poser.pugx.org/fsclaro/blackbird/license)](https://packagist.org/packages/fsclaro/blackbird)

## 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
```bash
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.
```bash
mysql -e 'create database ;' -u -p
```

Edit the *.env* file to modify the parameters below, according your database environment
```bash
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=
```

The default values are
```bash
DB_DATABASE=blackbird
DB_USERNAME=homestead
DB_PASSWORD=secret
```

After, run commands bellow in terminal:
```bash
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** | [email protected] | password |
| **User** | [email protected] | 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](https://github.com/fsclaro/blackbird/blob/master/CONTRIBUTING.md) on contributions and send me an email to [[email protected]](mailto:[email protected])

## Code of Conduct

It is very important that you read our [code of conduct](https://github.com/fsclaro/blackbird/blob/master/CODE_OF_CONDUCT.md) 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 [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## License

This project is open-sourced software licensed under the [MIT license](https://github.com/fsclaro/blackbird/blob/master/LICENSE.md).

## Credits

The background images at [Unplash](https://unsplash.com) by authors/photographers:
- [Adam Kedem](https://unsplash.com/@adamk)
- [Alessandro Valenzano](https://unsplash.com/@alessvalenzano)
- [Alexandre Chambon](https://unsplash.com/@goodspleen)
- [Boris Baldinger](https://unsplash.com/@borisbaldinger)
- [David Emrich](https://unsplash.com/@otoriii)
- [Francesco Ungaro](https://unsplash.com/@francesco_ungaro)
- [Iswanto Arif](https://unsplash.com/@iswanto)
- [Janita Top](https://unsplash.com/@janitatop)
- [Philipp Wüthrich](https://unsplash.com/@phiwut)
- [Piermanuele Sberni](https://unsplash.com/@piermanuele_sberni)