Skip to content

The PERSCOM Widget offers a simple and effective way to integrate your PERSCOM.io data externally into various websites and content management systems.

License

Notifications You must be signed in to change notification settings

deschutesdesigngroupllc/perscom-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

The Official PERSCOM Widget

The PERSCOM Widget offers a simple and effective way to integrate your PERSCOM.io data externally into various websites and content management systems.

Deployment

Documentation

Introduction

By using a straightforward HTML code snippet, the widget can elegantly render and present your data in a non-intrusive manner. Further, the widget can be fully customized using CSS to seamlessly blend with your website's aesthetics.

<!-- Place this code where you want the widget to appear on your website. -->
<!-- Replace APIKEY with your actual API key. -->

<div id="perscom_widget_wrapper">
    <script
        id="perscom_widget"
        data-apikey="APIKEY"
        data-widget="roster"
        data-dark="false"
        src="https://widget.perscom.io/widget.js"
        type="text/javascript"
    ></script>
</div>

Demo / Example

A live version of the widget can be viewed here. This demo uses data straight from our demo organization available at https://demo.perscom.io.

Getting Started

Explore the variety of available widgets:

Documentation

Visit our documentation here to get started.

Contributing

Please see here for more details about contributing.

Development

Available Development Commands

Navigate to the project directory and execute the following commands:

npm start

Launches the application in development mode.

npm start:widget

Initiates a local web server serving widget.js for local development.

npm test

Activates the test runner in interactive watch mode.

npm run build

Compiles the application for production into the build folder.

npm run build:widget

Compiles the widget for production into the dist folder. The compiled file will be named widget.js.

npm run format

Formats the source code of the application. Run before pull requests and repository pushes.

npm run lint

Executes ESLint to ensure source code adheres to best practices and syntax rules. Run before pull requests and repository pushes.

About

The PERSCOM Widget offers a simple and effective way to integrate your PERSCOM.io data externally into various websites and content management systems.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published