o3-panther-web

Simple helper library for SPAs to integrate with Panther

Installation

Install with npm install o3-panther-web.

Usage

The library is very simplistic. It may be loaded directly in a script tag, AMD, or ES6 project. The main use of the library is for accessing the Panther database and rendering templates. Other features will be incorporated as time permints.

Using the library within a script tag

    let panther = new o3PantherWeb();
    panther.render('#main', '7ce52ed1-9135-4905-b19b-248853ee91e1');

Configuration options during instantiation

    {
        "db": {
            "uri": "URI TO GRAPHQL ENDPOINT"
        },
        "template": {
            "type": "TABLE NAME",
            "field": "JSON FIELD FOR TEMPLATE",
            "id": "TABLE ID"
        }
    }

Contributing

We would love you to contribute to o3-panther-web, pull requests are very welcomed! Please see CONTRIBUTING.md for more information.

LICENSE

Apache-2.0