Runly provides OSS components under the banner of runly.js to integrate your frontend applications. These components are implemented using multiple frameworks & libraries and packaged in a variety of ways to allow you to seamlessly include them in your current workflow. Whether you have a build step for your JS or you just include script tags on server-rendered pages, we support you. ✊

Authentication

You will need to generate public API keys to be able to integrate your application with runly.js. These API keys allow you to authenticate to the Runly HTTP API. Since you will probably be using these components in a public environment (the browser), make sure any API keys you use with runly.js are public. Learn more about API key access.

Philosophy

These component libraries are built on a ladder. This means you can choose to integrate your application on any rung of that ladder. Whether you value ease of use or maximum customization, you can find a package that meets your needs.

We provide our packages on the public npm registry under our organization name, @runly.

Core Packages

These packages provide no components, only bare methods to connect to the Runly API. You can use these packages to easily authenticate and connect to the Runly API but build your own customized UI.

@runly/ui

This package provides a number of React Hooks that can be used to retrieve data from the Runly HTTP API.

Learn more about the runly.js core package.

Themed Components

@runly/bootstrap

React components implemented using the Bootstrap component library.

Learn more about the runly.js Bootstrap integration.

@runly/material

React components implemented using Material UI: a React implementation of Material Design.

@runly/react-bulma

React components implemented using the Bulma CSS framework.

@runly/react-foundation

React components implemented using the Foundation front-end framework.

Vanilla JS

The @runly/js package provides a way to integrate your application if you are not using any UI framework. You can use this to render components into a dynamic app that is using jQuery for example.

This script is also available via CDN.

HTML

This integration is intended for maximum ease-of-use for server-rendered pages that have very little scripting already on the page.

This script is only available via CDN.

Learn more about the runly.js HTML integration.

Other Integrations

Don’t see a framework or library you were really hoping to see? Let us know by opening an issue. Tell us which framework or library you would like to see runly.js implemented in and why it is awesome.

Next Steps