FM / docs

/home/techb158/ileadtechnology.com/vendor/spatie/laravel-query-builder/docs/

/home/techb158/ileadtechnology.com/vendor/spatie/laravel-query-builder/docs

Name	Size	Mode	Actions
advanced-usage/	-	0755	rm
features/	-	0755	rm
about-us.md	465	0644	edit dl rm
changelog.md	182	0644	edit dl rm
installation-setup.md	1070	0644	edit dl rm
introduction.md	3803	0644	edit dl rm
questions-issues.md	452	0644	edit dl rm
requirements.md	274	0644	edit dl rm
support-us.md	549	0644	edit dl rm
_index.md	149	0644	edit dl rm

Edit: /home/techb158/ileadtechnology.com/vendor/spatie/laravel-query-builder/docs/installation-setup.md (1070B)

---
title: Installation & setup
weight: 4
---

You can install the package via composer:

```bash
composer require spatie/laravel-query-builder
```

The package will automatically register its service provider.

You can optionally publish the config file with:
```bash
php artisan vendor:publish --provider="Spatie\QueryBuilder\QueryBuilderServiceProvider" --tag="config"
```

These are the contents of the default config file that will be published:

```php
return [

/*
     * By default the package will use the `include`, `filter`, `sort`
     * and `fields` query parameters as described in the readme.
     *
     * You can customize these query string parameters here.
     */
    'parameters' => [
        'include' => 'include',

'filter' => 'filter',

'sort' => 'sort',

'fields' => 'fields',

'append' => 'append',
    ],

/*
     * Related model counts are included using the relationship name suffixed with this string.
     * For example: GET /users?include=postsCount
     */
    'count_suffix' => 'Count',

];
```

--- title: Installation & setup weight: 4 --- You can install the package via composer: ```bash composer require spatie/laravel-query-builder ``` The package will automatically register its service provider. You can optionally publish the config file with: ```bash php artisan vendor:publish --provider="Spatie\QueryBuilder\QueryBuilderServiceProvider" --tag="config" ``` These are the contents of the default config file that will be published: ```php return [ /* * By default the package will use the `include`, `filter`, `sort` * and `fields` query parameters as described in the readme. * * You can customize these query string parameters here. */ 'parameters' => [ 'include' => 'include', 'filter' => 'filter', 'sort' => 'sort', 'fields' => 'fields', 'append' => 'append', ], /* * Related model counts are included using the relationship name suffixed with this string. * For example: GET /users?include=postsCount */ 'count_suffix' => 'Count', ]; ```