Skip to content

Commit 5d7638a

Browse files
committed
Merge branch 'master' of github.com:luciano-jr/Laravel-API-query-handler
2 parents cc93a0a + 954936d commit 5d7638a

File tree

3 files changed

+102
-0
lines changed

3 files changed

+102
-0
lines changed

.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
vendor/
2+
node_modules/
3+
npm-debug.log
4+
5+
# Laravel 4 specific
6+
bootstrap/compiled.php
7+
app/storage/
8+
9+
# Laravel 5 & Lumen specific
10+
public/storage
11+
public/hot
12+
storage/*.key
13+
.env.*.php
14+
.env.php
15+
.env
16+
Homestead.yaml
17+
Homestead.json
18+
19+
# Rocketeer PHP task runner and deployment package. https://github.com/rocketeers/rocketeer
20+
.rocketeer/

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Luciano Jr
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 all
13+
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 THE
21+
SOFTWARE.

README.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# [WIP] Laravel API query handler
2+
This Laravel package helps to handle a query request properly
3+
4+
## Synopsis
5+
6+
In order to help
7+
8+
## Code Example
9+
10+
Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
11+
12+
## Motivation
13+
14+
A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
15+
16+
## Installation
17+
18+
Require this package with composer using the following command:
19+
20+
```bash
21+
composer require luciano-jr/laravel-api-query-handler
22+
```
23+
24+
After updating composer, add the service provider to the `providers` array in `config/app.php`
25+
26+
```php
27+
Luciano-Jr\LaravelAPIQueryHandler\Services\ServiceProvider::class,
28+
```
29+
30+
### Configuration File
31+
32+
**If you use Lumen please skip this step**
33+
34+
If you want to change the default parameters, run this command on the terminal in order to publish the vendor config file:
35+
36+
`php artisan vendor:publish --provider="Luciano-Jr\LaravelApiQueryHandler\Services\ServiceProvider"`
37+
38+
39+
## Usage
40+
41+
```
42+
public function index(Request $request)
43+
{
44+
$collection = $this->repository->all();
45+
46+
$collectionHandler = new CollectionHandler($collection, $request);
47+
$collectionHandler->handle();
48+
}
49+
```
50+
51+
## Tests
52+
53+
Describe and show how to run the tests with code examples.
54+
55+
## Contributors
56+
57+
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
58+
59+
## License
60+
61+
The Laravel API query handler is open-sourced software licensed under the MIT license.

0 commit comments

Comments
 (0)