Giter VIP home page Giter VIP logo

respoke-php's Introduction

Respoke PHP Library Build Status

Respoke PHP is the officially supported PHP library for Respoke.

With Respoke, you can add live voice, video, text and data features to your website or mobile app. Check out our Guides to get started using Respoke and Respoke PHP now.

Please validate you have PHP 5.4.* or greater installed.

Installation

Install Respoke's PHP Library to your project using Composer.

composer require respoke/respoke

Running the library

Install the library's dependencies.

composer install

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Then use the library. Request access to Respoke at the Respoke website.

use Respoke\Client;

$client = new Respoke\Client([
    "appId" => "APP_ID",
    "appSecret" => "APP_SECRET",
    "roleId" => "ROLE_ID",
    "endpointId" => "USER_NAME"
]);

$tokenId = $client->getTokenId();

Return this $tokenId to your front-end and pass it to the token property when connecting to Respoke.

json_encode(["token" => $tokenId]);

Running the tests

The test suite uses PHPUnit for test coverage.

phpunit --configuration phpunit.xml.dist

Contributing

If you wish to submit an issue use the issue tracker.

  1. Fork it ( https://github.com/[my-github-username]/respoke-php/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -a -m 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Cutting a new release

PHPRelease is used to release a new version of this package. Details of the use of PHPRelease can be found on the project's readme.

This project follows semantic versioning. The tl;dr of semver is:

  • new major version when there are breaking changes to the public api of the library.
  • new minor version when there are backward-compatible changes to the api, such as new features.
  • new patch version when there are backward-compatible bug fixes, or other changes that do not affect the public API.

License

This source code is licensed under The MIT License.

respoke-php's People

Contributors

tiandavis avatar chadxz avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.