Skip to content
This repository has been archived by the owner on Oct 28, 2021. It is now read-only.

Latest commit

 

History

History
37 lines (26 loc) · 2.76 KB

README.md

File metadata and controls

37 lines (26 loc) · 2.76 KB
Raw

Build Status semantic-release bitHound Overall Score bitHound Dependencies bitHound Dev Dependencies bitHound Code

Integrations Front-End Commons Documentation

This document provides a brief overview of "Integration Front-End Commons" components and how to build and publish them.

Overview

Integration FE Commons provides the common components required to build a webhook configurator application for a Symphony Integration. It provides commonly used components to build configurator apps, such as room search, webhook creation, webhook editing etc. It also provides the complete Configurator App workflow for viewing, creating, editing and deleting webhooks.

Installation instructions for the Javasctipt developer

What you’ll build

You’ll build the Javascript library that provides some useful services to build new configurator apps for integrations.

What you’ll need

  • Nodejs 6.10
  • NPM node-license-validator
  • NPM semantic-release

Build with NPM

To start from scratch, do the following:

  1. Clone the source repository using Git: git clone git@github.com:symphonyoss/App-Integrations-FE-Commons.git
  2. cd into App-Integrations-FE-Commons
  3. Build using npm: npm install

Publishing

The "Integration Front-End Commons" library is published on npm registry via Travis. In order to publish your changes, submit a Github Pull Request to the "dev" branch bumping the version at package.json, and the changes will be publish at https://www.npmjs.com/package/symphony-integration-commons.

Samples

To understand how to use the componentes provided by the "Integration Front-End Commons", check the following samples: posting-location-sample and out-of-the-box-configurator.