Home Reference Source Test

reTHINK Service Framework

Build status

Master Develop
Build Status Build Status


In order to try speed up the instalation process, we remove the first verification of global modules, so, if you want install this repository, you should install globaly this modules:

npm install -g karma-cli gulp-cli browserify

ReThink Framework Overview

reTHINK provides a Javascript framework to build and deliver Real Time Communication Microservices in end-user devices (browsers and standalone mobile apps) and in Network edge servers (NodeJS):

In case you want want to know more details about reTHINK, have a look here

Quick Start

The first thing you need for the quick start, is to setup up your development environment and play around with some available tutorials that highlight the main reTHINK concepts. These Information can be found in the links below.

Installation as a NPM Module;

How to include this repository in other software parts, like dev-runtime-browser, dev-runtime-node or dev-runtime-core;

npm install

To import the dev-service-framework modules:

// This is the default class exported;
import CatalogueFactory from 'service-framework/dist/CatalogueFactory';

// This is the other classes exported
import {HypertyDescriptor, ProtocolStubDescriptor, SourcePackage} from 'service-framework/dist/CatalogueFactory';

// or
import MessageFactory from 'service-framework/dist/MessageFactory';

// or
import {Syncher, DataObjectReporter, DataObjectObserver} from 'service-framework/dist/Syncher';

Old Way - Depreciated!!!

Another way to import classes from the Service Framework that will be only supported until the runtime-core and other repositories are update to the "new way":

import {Syncher, MessageFactory} from 'service-framework';

console.log('Syncher: ', Syncher);
console.log('MessageFactory: ', MessageFactory);

If you have problems with the npm install service framework module, you should check Github Help. and select the operation system you are using.

How to contribute

This section provides guidelines on how to contribute to reTHINK Service Framework. Contributions to other reTHINK components should follow its own guidelines:


npm test # start the karma tests
npm run test:lint # check the code if respect the codestyle
npm run build:doc # generate/update documentation
npm run build:dev # build the service framework modules into bundles to be used on development environment
npm run build:prod # build the service framework modules into bundles to be used on production environment