Panel UI ·

General Research Supplier and Panel Interface

This project provides various front-end React components that leverage the General Research Full-Service Brokerage API. There are no private API calls or functionality.

Integration Example

<script
    src="https://cdn.generalresearch.com/grl-panel.js"
    //-- Essential:
    // -- This is your Product ID. Provided by General Research
    data-bpid="d0606a0b5d034a8d81b1e3579d1f76fd"

    // -- The ID of a div on the page that you would like to widget
    //      to be placed. Allows custom resizing and styling of the
    //      Panel UI widget
    data-target="div9f1dcb68"

    // -- The Brokerage Product User ID, a unique user 
    //      identifier. Should be a random uuid or hash 
    //      that is consistent for a user.
    data-bpuid="grl-panel-ui-example-c67bfe924d80"

    //-- User Interface Configuration
    data-panel="General Insights"
></script>

Build Status and Content Delivery

Branches	Versions

Please click on the build status badges to access the CDN hosted javascript for you to use.

How to build your own Panel UI

Running Development

npm install
npm dev

Building Production

npm install
npm build

If successful, a single file will be generaged at /dist/grl-panel.js which you can then use to place on your own CDN or web server.

API Documentation and Interfaces

A design pattern and goal of the Panel UI project is to not use any proprietary or custom models or object definitions within the project itself. By leveraging openapi-generator-cli all the required models and API endpoints can be built from the General Research https://fsb.generalresearch.com/redoc/ openapi file available here.

This project contains the prebuilt interfaces and endpoint classes for the API. However, instructions to build it yourself is available in the @/src/api/README.md file.

License

Panel UI is MIT licensed.

Do what you want, just give credit.