retsly-js-sdk

    0.8.6 • Public • Published

    wercker status

    retsly-js-sdk

    Retsly core SDK. Useful for clientside integration with Retsly.

    The Retsly JavaScript SDK is a toolkit that allows you to build robust realtime applications without the need for a database or a server. On top of this SDK is a component system that allows developers to create reusable plug and play components.

    To use this you will need to create an application of Retsly

    You can learn more from our API Docs.

    Installation

    Quick start

    1. Include the hosted retsly-js-sdk in your <head> tag.
    <head>
      <!-- Include the SDK -->
      <script src='https://rets.ly/js/sdk'></script> 
    </head>
     
    <body>
      <!-- Content -->
    </body>
     
    <!-- Get listing data from "test" vendor -->
    <script type="text/javascript">
      var retsly = new Retsly(YOUR_CLIENT_ID, YOUR_JS_TOKEN);
      retsly.ready(function(){
        // '/api/v1/<vendor>/<resource>.json'
        retsly.get('/api/v1/test/listings.json', {limit: 10}, function(res){
          if (!res.success) throw new Error(res.bundle);
          console.log(res);
        });
      });
    </script> 

    NOTE:

    If you are testing on localhost. It is important to update your Http Referrer Domain and OAuth settings in your application settings to match you testing url.

    Use with Browserify

    1. First install with npm:
    $ npm install retsly-js-sdk
    1. Next, anywhere that you want to use the retsly-js-sdk simply require('retsly-js-sdk'). Below is an example of using this in main.js
    /**
     * main.js
     */
     
    // Dependency
    var Retsly = require('retsly-js-sdk');
     
    var retsly = new Retsly(<YOUR_CLIENT_ID>, <YOUR_JS_TOKEN>);
     
    retsly.ready(function(){
      // '/api/v1/<vendor>/<resource>.json'
      retsly.get('/api/v1/test/listings.json', {limit: 10}, function(res){
        if (!res.success) throw new Error(res.bundle);
        console.log(res);
      });
    });
    1. When you are ready to start compiling, follow the general Browserify procedure. Here is an example with compiling main.js to target.js
    $ browserify main.js -o target.js

    For More information on how to use browserify, go to the docs

    1. Finally, drop a single <script> tag into your html file with the compiled script:
    <script src="target.js"></script>

    Now you should be able to make use of all of the Retsly API endpoints via the retsly-js-sdk

    Build from source

    Clone the repo and build the standalone file retsly.js:

    $ git clone https://github.com/Retsly/retsly-js-sdk
    cd retsly-js-sdk
    $ make dist

    Include in your project:

    <script src='/path/to/retsly.js'></script>

    This will export the client SDK as an AMD or CommonJS module, or window.Retsly.

    Use with Phonegap

    You'll need to add rets.ly and rets.io to your application's whitelist. See the Whitelist Guide for instructions.

    Repo Owner

    Jason Wan

    License

    (The MIT License)

    Copyright (c) 2014 Retsly Software Inc support@rets.ly

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i retsly-js-sdk

    DownloadsWeekly Downloads

    1

    Version

    0.8.6

    License

    none

    Last publish

    Collaborators

    • himanshu_jain
    • cmclay
    • retslybot
    • amartens
    • jay.lee
    • jwleddy
    • chrislaue
    • jkhwan
    • kregensberg
    • lvivier
    • eanh
    • arpitsingh1
    • theo-ng
    • nichole
    • keithm
    • enfinlay
    • davorind