enoa-client

0.0.11 • Public • Published

Enoa Client

Javascript client which is able to integrate multi adapters at the same time even in different envoirments

Version travis-svg Downloads dependencies Status

License Gitter StackVverflow

Overview

The enoa-client is a universal JavaScript client, which enables in combination with an ADAPTER, Client-Server Side communications. Recommended Use Cases are e.g the use of web services(fallback, retry, CDN, timeout strategies thus minimizing bottlenecks for High-Availablity on the client-side). The modular structure includes the options of server-sided(Node.JS) as well as browser-sided(Vanilla, jQuery, AngularJS) client implementations. Recommended adapters can be found at Emallates.

Please feel free to use our adapter examples as the structure for your own customized adapters! Recommendations and improvement hints concerning the structure of the enoa-client and the adapters , therefore, are always very welcome!

Community Adapters

  • Server-side

Installation

Several installation options are available:

Usage

Server side NodeJS ( example with ZLogJS-Adapter )

var enoaClient = require('enoa-client');
var zlogjsAdapter = require('zlogjs-adapter');
var configs = {
port:'9000',
mode:"central",
host:'localhost', 
appId:'your-appid',
apiKey:'your-apiKey',
adapter:zlogjsAdapter
}
enoaClient = enoaClient({ appId:'appId', apiKey:'apiKey', collections:{zlog:configs}});

VanilaJS

<script type="text/javascript" src="path/to/enoaclient.vanilla.min.js"></script>
<script type="text/javascript">
	var enoaClient = windos.enoaclient(options)
</script>

jQuery

<script type="text/javascript" src="path/to/jquery.js"></script>
<script type="text/javascript" src="path/to/enoaclient.jquery.min.js"></script>
<script type="text/javascript">
	var enoaClient = jQuery.enoaClient(options);
</script>

AngularJS

This package will use $http for HTTP communication.

<script type="text/javascript" src="path/to/angular.js"></script>
<script type="text/javascript" src="path/to/enoaclient.angular.min.js"></script>
<script type="text/javascript">
	var app = angular.module('app', ['enoa'])
	app.service('client', ['enoaclient', function(enoaclient){
		return enoaclient({appId:"_appId", apiKey:"_apiKey"})
	}]);
	app.controller('ctrl', ['client', '$scope', function(client, $scope){
		// Now you can use client service anywaher in your project
	}]);
</script>

CONTRIBUTION

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Build from source

  1. clone git repository git clone https://github.com/Emallates/enoa-client.git
  2. Run npm install
  3. Run npm run build

Tests

Coming soon

Community

Copyright and license

Code and documentation copyright 2011-2016 Emallates, Inc. Code released under the MIT license. Docs released under Creative Commons.

Readme

Keywords

none

Package Sidebar

Install

npm i enoa-client

Weekly Downloads

32

Version

0.0.11

License

MIT

Last publish

Collaborators

  • emallates