Skip to content
This repository was archived by the owner on Oct 8, 2019. It is now read-only.

Commit 7eedfa7

Browse files
committed
First commit
0 parents  commit 7eedfa7

39 files changed

+2778
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
vendor/
2+
.idea/
3+
.vscode/
4+
.DS_Store

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Pascal Boucher <pascalboocher@gmail.com>
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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Laravel Chatkit API
2+
3+
An API wrapper for Pusher Chatkit.
4+
5+
## Installation
6+
7+
```
8+
composer require chess/laravel-chatkit-api
9+
10+
php artisan vendor:publish --provider="Chess\Chatkit\ChatkitServiceProvider"
11+
```
12+
13+
If you're using Laravel 5.5+ this is all there is to do.
14+
15+
For Laravel versions before 5.5, you must register the service provider in your `config/app.php`
16+
17+
1) Add a new item to the providers array:
18+
19+
```php
20+
Chess\Chatkit\ChatkitServiceProvider::class,
21+
```
22+
23+
2) Add a new item to the aliases array:
24+
25+
```php
26+
'Chatkit' => Chess\Chatkit\Facades\Chatkit::class,
27+
```
28+
29+
## Usage
30+
31+
Include the Facade class at the top of your file
32+
33+
```
34+
use Chatkit;
35+
```
36+
37+
The rest of the documentation can be found in the project's wiki section.
38+
39+
[Documentation](https://github.com/pascalboucher/laravel-chatkit-api/wiki)
40+
41+
## Credits
42+
43+
- [Pascal Boucher](https://github.com/pascalboucher)
44+
45+
## License
46+
47+
laravel-chatkit-api is open-sourced software licensed under the [MIT license](https://github.com/pascalboucher/laravel-chatkit-api/blob/master/LICENSE.md)
48+

composer.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "chess/laravel-chatkit-api",
3+
"description": "Laravel wrapper for the pusher chatkit api",
4+
"license": "MIT",
5+
"keywords": ["laravel", "pusher", "chatkit", "api"],
6+
"type": "library",
7+
"authors": [
8+
{
9+
"name": "Pascal Boucher",
10+
"email": "pascalboocher@gmail.com"
11+
}
12+
],
13+
"require": {
14+
"php": ">=7.1.3",
15+
"ext-fileinfo": "*",
16+
"illuminate/support": "^5.6",
17+
"guzzlehttp/guzzle": "^6.3",
18+
"pusher/pusher-chatkit-server": "^0.5.0",
19+
"illuminate/cache": "^5.6",
20+
"illuminate/filesystem": "^5.6",
21+
"kevinrob/guzzle-cache-middleware": "^3.2"
22+
},
23+
"autoload": {
24+
"psr-4": {
25+
"Chess\\Chatkit\\": "src/"
26+
}
27+
},
28+
"extra": {
29+
"laravel": {
30+
"providers": [
31+
"Chess\\Chatkit\\ChatkitServiceProvider"
32+
],
33+
"aliases": {
34+
"Chatkit": "Chess\\Chatkit\\Facades\\Chatkit"
35+
}
36+
}
37+
}
38+
}

0 commit comments

Comments
 (0)