Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit d183fe0

Browse files
committed
Added License and update readme
1 parent e796ca5 commit d183fe0

File tree

2 files changed

+66
-27
lines changed

2 files changed

+66
-27
lines changed

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) <Nasrul Hazim>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 45 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,9 @@
22

33
# Laravel Boilerplate
44

5-
A boilerplate to speed up web application development.
5+
A boilerplate based on Laravel Framework to speed up web application development setup.
66

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
298

309
1. [Cleanique Coders](https://github.com/cleaniquecoders)
3110

@@ -53,15 +32,54 @@ There's some commands area ready built-in. Others, may refer to respective packa
5332
5. [Sweet Alert](https://github.com/uxweb/sweet-alert)
5433
6. [Sempro PHPUnit Pretty Printer](https://github.com/Sempro/phpunit-pretty-print)
5534

56-
# Setup
35+
## Installation
5736

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
5948

6049
Create [Google Service Account Credentials](https://console.developers.google.com/apis/dashboard?project=karnival-usahawan-desa) for:
6150

6251
1. [Google Calendar](https://github.com/spatie/laravel-google-calendar#how-to-obtain-the-credentials-to-communicate-with-google-calendar)
6352
2. [Google Analytic](https://github.com/spatie/laravel-analytics#how-to-obtain-the-credentials-to-communicate-with-google-analytics)
6453

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
6684

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

Comments
 (0)