# Installation

The instructions below will help you to properly installand run the generated package to the lavalite project.

## Location

Extract the package contents to the folder 

`/packages/bixo/company/`

## Composer

Add the below entries in the `composer.json`.


```json

...
     "repositories": {
        ...

        {
            "type": "path",
            "url": "packages/bixo/company"
        }

        ...
    },
...

```
Then run `composer require bixo/company`


## Migration and seeds

```
    php artisan migrate
    php artisan db:seed --class=Bixo\\Company\\Seeders\\CompanyTableSeeder
```

## Publishing

* Configuration
```
    php artisan vendor:publish --provider="Bixo\Company\Providers\CompanyServiceProvider" --tag="config"
```
* Language
```
    php artisan vendor:publish --provider="Bixo\Company\Providers\CompanyServiceProvider" --tag="lang"
```
* Views
```
    php artisan vendor:publish --provider="Bixo\Company\Providers\CompanyServiceProvider" --tag="view"
```

## URLs and APIs

### Web Urls

* Admin
```
    http://path-to-route-folder/admin/company/{modulename}
```

* User
```
    http://path-to-route-folder/user/company/{modulename}
```

* Public
```
    http://path-to-route-folder/companies
```


### API endpoints

These endpoints can be used with or without `/api/`
And also the user can be varied depend on the type of users, eg user, client, admin etc.

#### Resource

* List
```
    http://path-to-route-folder/api/user/company/{modulename}
    METHOD: GET
```

* Create
```
    http://path-to-route-folder/api/user/company/{modulename}
    METHOD: POST
```

* Edit
```
    http://path-to-route-folder/api/user/company/{modulename}/{id}
    METHOD: PUT
```

* Delete
```
    http://path-to-route-folder/api/user/company/{modulename}/{id}
    METHOD: DELETE
```

#### Public

* List
```
    http://path-to-route-folder/api/company/{modulename}
    METHOD: GET
```

* Single Item
```
    http://path-to-route-folder/api/company/{modulename}/{slug}
    METHOD: GET
```

#### Others

* Report
```
    http://path-to-route-folder/api/user/company/{modulename}/report/{report}
    METHOD: GET
```

* Export/Import
```
    http://path-to-route-folder/api/user/company/{modulename}/exim/{exim}
    METHOD: POST
```

* Action
```
    http://path-to-route-folder/api/user/company/{modulename}/action/{id}/{action}
    METHOD: PATCH
```

* Actions
```
    http://path-to-route-folder/api/user/company/{modulename}/actions/{action}
    METHOD: PATCH
```

* Workflow
```
    http://path-to-route-folder/api/user/company/{modulename}/workflow/{id}/{transition}
    METHOD: PATCH
```