|
2 | 2 |
|
3 | 3 | # Laravel Boilerplate |
4 | 4 |
|
5 | | -A boilerplate to speed up web application development. |
| 5 | +A boilerplate based on Laravel Framework to speed up web application development setup. |
6 | 6 |
|
7 | | -# Installation |
8 | | - |
9 | | -``` |
10 | | -$ composer create-project cleaniquecoders/laravel-boilerplate |
11 | | -``` |
12 | | - |
13 | | -Configure your `.env`, then: |
14 | | - |
15 | | -``` |
16 | | -$ php artisan reload:db |
17 | | -``` |
18 | | - |
19 | | -# Usage |
20 | | - |
21 | | -## Commands |
22 | | - |
23 | | -There's some commands area ready built-in. Others, may refer to respective packages. |
24 | | - |
25 | | -- `reload:db` - Run `migrate:fresh --seed` with `profile:seed`. You may extend the usage. |
26 | | -- `reload:cache` - Recache everything |
27 | | - |
28 | | -# Packages |
| 7 | +## Packages |
29 | 8 |
|
30 | 9 | 1. [Cleanique Coders](https://github.com/cleaniquecoders) |
31 | 10 |
|
@@ -53,15 +32,54 @@ There's some commands area ready built-in. Others, may refer to respective packa |
53 | 32 | 5. [Sweet Alert](https://github.com/uxweb/sweet-alert) |
54 | 33 | 6. [Sempro PHPUnit Pretty Printer](https://github.com/Sempro/phpunit-pretty-print) |
55 | 34 |
|
56 | | -# Setup |
| 35 | +## Installation |
57 | 36 |
|
58 | | -## Google API |
| 37 | +``` |
| 38 | +$ composer create-project cleaniquecoders/laravel-boilerplate |
| 39 | +``` |
| 40 | + |
| 41 | +Configure your `.env`, then: |
| 42 | + |
| 43 | +``` |
| 44 | +$ php artisan reload:db |
| 45 | +``` |
| 46 | + |
| 47 | +### Google API |
59 | 48 |
|
60 | 49 | Create [Google Service Account Credentials](https://console.developers.google.com/apis/dashboard?project=karnival-usahawan-desa) for: |
61 | 50 |
|
62 | 51 | 1. [Google Calendar](https://github.com/spatie/laravel-google-calendar#how-to-obtain-the-credentials-to-communicate-with-google-calendar) |
63 | 52 | 2. [Google Analytic](https://github.com/spatie/laravel-analytics#how-to-obtain-the-credentials-to-communicate-with-google-analytics) |
64 | 53 |
|
65 | | -# TODO |
| 54 | +## Usage |
| 55 | + |
| 56 | +### Commands |
| 57 | + |
| 58 | +There's some commands area ready built-in. Others, may refer to respective packages. |
| 59 | + |
| 60 | +- `reload:db` - Run `migrate:fresh --seed` with `profile:seed`. You may extend the usage. |
| 61 | +- `reload:cache` - Recache everything |
| 62 | + |
| 63 | +## Test |
| 64 | + |
| 65 | +To run the test, type `vendor/bin/phpunit` in your terminal. |
| 66 | + |
| 67 | +To have codes coverage, please ensure to install PHP XDebug then run the following command: |
| 68 | + |
| 69 | +``` |
| 70 | +$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr |
| 71 | +``` |
| 72 | + |
| 73 | +## Contributions |
| 74 | + |
| 75 | +Everyone are welcome to contribute to this package. However, it's a good practice to provide: |
| 76 | + |
| 77 | +1. The problem you solved |
| 78 | +2. Provide test |
| 79 | +3. Documentation |
| 80 | + |
| 81 | +Without these 3, you may add extra work for the maintainer. |
| 82 | + |
| 83 | +## License |
66 | 84 |
|
67 | | -1. Media Library for User |
| 85 | +This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT). |
0 commit comments