Dashboard

Getting started

This documentation will help you to use hull. It provides reference for the different APIs and libraries for the platform.

Hull.js

Hull comes with a wide library of widgets. The Widgets page show you the complete list of the packaged widgets offered by hull.

Get started with hull.js

API

If you want to go further or want to build widgets, check out the API. It lets you explore the API in great detail, with every call, object and method listed there.

Peruse our API

Quick Start

Configure & install your app:

  • Go to your Admin panel, create your organization, app, and configure your services.

  • Insert the hull.js library in your page. It should look like this:

    <!-- hull.js require jQuery (or Zepto) -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
<script src="https://d3f5pyioow99x0.cloudfront.net/develop/hull.js"></script>

  • Initialize the library by running Hull.init()

    Hull.init({
  appId: "YOUR_APP_ID",
  orgUrl: "YOUR_ORGANIZATION_URL"
});

You can find the values for YOUR_APP_ID and YOUR_ORGANIZATION_URL in the Admin panel

  • Declare Widgets in your HTML where you want them.
  • That's it. The library inserts live widgets, your app is social.

Go further:

  1. Customize markup and behaviour with templates
  2. Write your own widgets, starting from existing widgets or from scratch
  3. Query the Graph API directly from the browser to retreive custom data

Talk to us

Are you in trouble?

Head out to Github Issues pages for the project.

Are you really cool?

Contribute to the project with widgets, and open source apps !

If you still need help or just want to say hi.

Ping us on Twitter or contact us by email