mithleshjs / laravel-parse-sdk
Parse SDK Bridge for Laravel 5 with support for self-hosted Parse Server
Requires
- php: >=5.5.9
- illuminate/contracts: 5.1.*|5.2.*
- illuminate/support: 5.1.*|5.2.*
- parse/php-sdk: 1.2.*
Requires (Dev)
- graham-campbell/testbench: ^3.1
- phpunit/phpunit: ^4.8|^5.0
README
Laravel Parse was created by, and is maintained by Graham Campbell, and is a Parse SDK bridge for Laravel 5 with support for self-hosted Parse Server. Feel free to check out the change log, releases, license, and contribution guidelines.
Installation
Either PHP 5.5+ or HHVM 3.6+ are required.
To get the latest version of Laravel Parse, simply require the project using Composer:
$ composer require mithleshjs/laravel-parse-sdk
Instead, you may of course manually update your require block and run composer update
if you so choose:
{ "require": { "mithleshjs/laravel-parse-sdk": "^2.4" } }
Once Laravel Parse is installed, you need to register the service provider. Open up config/app.php
and add the following to the providers
key.
'GrahamCampbell\Parse\ParseServiceProvider'
Configuration
Laravel Parse requires configuration/
To get started, you'll need to publish all vendor assets:
$ php artisan vendor:publish
This will create a config/parse.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
There are three config options:
Parse App Id
This option ('app_id'
) is where you may specify your parse app id. The default value for this setting is 'your-app-id'
.
Parse Rest Key
This option ('rest_key'
) is where you may specify your parse rest key. The default value for this setting is 'your-rest-key'
.
Parse Master Key
This option ('master_key'
) is where you may specify your parse master key. The default value for this setting is 'your-master-key'
.
Parse Server URL
This option ('server_url'
) is where you may specify your parse server url. The default value for this setting is 'your-server-url'
.
Usage
This package is only responsible for the automatic initialisation of the parse client. See the parse docs at https://github.com/ParsePlatform/parse-php-sdk.
Security
If you discover a security vulnerability within this package, please send an e-mail to Graham Campbell at graham@alt-three.com. All security vulnerabilities will be promptly addressed.
License
Laravel Parse is licensed under The MIT License (MIT).