accessibility.cloud v2.2.0

Accessibility Cloud API – JavaScript example application

This is a small and easy-to-use client-side JS library that helps with…

• fetching data from accessibility.cloud via its API
• formatting the JSON server response as HTML
• handling attribution / credits as required by licenses

Keep in mind that this library is still under development and likely to change.

Running the example

Right now the sourcecode of the example integration resides inside the repository. To get it running you have to go through the following steps:

Sign up / in

1. Open https://www.accessibility.cloud
2. Click Sign up or Login

Obtain an API token

3. Create an organization

4. Fill out and submit the organization form and submit. You will be forwared to the organization view.

5. Click "API Clients" in the header

6. Click "Add API client", fill out and submit the form.

7. Copy your API access token.

   

Run the client

8. Clone or download the repository.
9. Open index.html with your favorite text editor and replace the API token around line 22 with the one you copied from the API token page.
10. Open index.html in your web-browser. The result should look similar to this:

Comments on the code

To balance readibility and code size, we're using the Mustache template engine (10k) and jQuery. To not duplicate libraries on your side, how you integrate jQuery is up to you (index.html contains an example how). The only relevant files to use in your project are dist/accessibility.cloud.min.js (our JS library), accessibility.cloud.css (the CSS -- it's up to you to customize it to fit your own project's styling). Check dist/index.html for an example how to include accessibility.cloud.js.

index.html

This is a very short file. Its main purpose is to execute the following script:

<script>
  $(function() {
    var AccessibilityCloud = window['accessibility.cloud'].default;
    var accessibilityCloud = new AccessibilityCloud({
      token: '7f039b60e27a4d02b13c5ad79fbe9d7b', // <-- Replace this token with your own
      locale: 'de' // <-- Replace this with the locale you want to use
    });

    var element = document.querySelector('.ac-results');

    // These parameters are passed to the JSON API's GET /place-infos endpoint.
    // More documentation is here:
    // https://github.com/sozialhelden/accessibility-cloud/blob/master/docs/json-api.md#get-place-infos
    var parameters = {
      latitude: 40.728292,
      longitude: -73.9875852,
      accuracy: 10000,
      limit: 100,
    };

    accessibilityCloud.loadAndRenderPlaces(element, parameters, console.log);
  });
</script>

Note that the script above includes the API token, which you have to replace with the one you get on accessibility.cloud for your own API client. It also includes an example request (in this case for places in Manhattan).

The loadAndRenderPlaces function renders the results in the given element. It optionally accepts a callback in NodeJS function (error, result) { … } style.

For more information on the available parameters, refer to the documentation on the API.

accessibility.cloud.js

This is the library's main file. It includes a few library and is built and minified using webpack.

Building the library yourself

• Set up the build toolchain with npm install
• Run npm run build to create a minified build in the dist/ directory
• Open dist/index.html to test the functionality
• Run npm version [major|minor|patch] to create a new library version

Translating

Translation process

Translations are created using transifex.

You can add translations by using c3po's t function in the code. The library works similar to gettext, but template string insertion and plurals are not supported (yet).

New translations are automatically synced to transifex when you build a new version with npm run build or when you create a new version with npm version [major|minor|patch].

How translation syncing works internally

• Pushing translations: When building with npm run build, the C3PO library creates a PO template file with all found strings from our source code in dist/translations.pot. This file is pushed to transifex with tx push -s dist/translations.pot.
• Pulling translations: When all strings are translated there, you can build a new version with npm version, which runs tx pull -a. This downloads the translations from transifex and stores them as .po-Files in the translations/ directory. The build process extracts the strings from there and stores them in translations.js. This ES6 module contains all translations as JS object-structure.