This repository has been archived by the owner on Oct 28, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Changed README as this is a Javascript repository only. - Added map-stream to license validator. - modified travis.yml as this is a Javascript only project.
- Loading branch information
Evandro Carenho
committed
Mar 27, 2017
1 parent
dc589e6
commit 09662e2
Showing
3 changed files
with
19 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,26 @@ | ||
[![Symphony Software Foundation - Incubating](https://cdn.rawgit.com/symphonyoss/contrib-toolbox/master/images/ssf-badge-incubating.svg)](https://symphonyoss.atlassian.net/wiki/display/FM/Incubating) [![Build Status](https://travis-ci.org/symphonyoss/App-Integrations-Commons.svg?branch=dev)](https://travis-ci.org/symphonyoss/App-Integrations-Commons) | ||
|
||
# Integrations Commons Documentation | ||
# Integrations Front-End Commons Documentation | ||
|
||
This document provides a brief overview of Integration Commons components and how to build them from scratch. | ||
This document provides a brief overview of Integration Front-End Commons components and how to build and publish them. | ||
|
||
# Overview | ||
|
||
Integration Commons provides the common components required to build a new integration to Symphony Platform, as the common base class for any WebHook based integration, Symphony authentication utility classes, metrics tools, and many other utility classes. | ||
Integration FE Commons provides the common components required to build a configurator application for Symphony Platform integrations, such as room search, webhook creation, webhook editing etc. | ||
|
||
The third-party services that would like to post messages into a configurable set of streams should define the integration-parent as a parent of your maven project. | ||
|
||
Example: | ||
|
||
``` | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<parent> | ||
<artifactId>integration-parent</artifactId> | ||
<groupId>org.symphonyoss</groupId> | ||
<version>0.10.0-SNAPSHOT</version> | ||
</parent> | ||
<modelVersion>4.0.0</modelVersion> | ||
<artifactId>integration-test</artifactId> | ||
<dependencies> | ||
<dependency> | ||
<groupId>org.symphonyoss.symphony.integrations</groupId> | ||
<artifactId>integration-webhook</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
</dependencies> | ||
</project> | ||
``` | ||
|
||
If you want to create a new webhook integration you should define the __integration-webhook__ module as a dependency and start by extending the [WebHookIntegration](integration-webhook/src/main/java/org/symphonyoss/integration/webhook/WebHookIntegration.java) class, as it is the super class of every other integration. | ||
|
||
# Installation instructions for the Java developer | ||
# Installation instructions for the Javasctipt developer | ||
|
||
### What you’ll build | ||
You’ll build a simple java library that provides some useful services to build new integrations. | ||
You’ll build a simple Javascript library that provides some useful services to build new configurator apps for integrations. | ||
|
||
### What you’ll need | ||
* JDK 1.7 | ||
* Maven 3.0.5+ | ||
|
||
### Build with maven | ||
Integration Commons is compatible with Apache Maven 3.0.5 or above. If you don’t already have Maven installed you can follow the instructions at maven.apache.org. | ||
* 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-Commons.git` | ||
2. cd into _App-Integrations-Commons_ | ||
3. Build using maven: `mvn clean install` | ||
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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters