smartuniverse/readme.md

56 lines
2.7 KiB
Markdown
Raw Normal View History

2019-01-31 01:52:18 +00:00
# @pushrocks/smartuniverse
messaging service for micro services
2018-04-13 13:45:48 +00:00
2019-01-31 01:52:18 +00:00
## Availabililty and Links
2019-04-22 22:28:57 +00:00
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
2018-04-04 15:39:48 +00:00
## Status for master
2019-01-31 01:52:18 +00:00
[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
2018-04-05 15:39:39 +00:00
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
2019-01-31 01:52:18 +00:00
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
2019-04-11 09:11:45 +00:00
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2018-04-04 15:39:48 +00:00
## Usage
2018-04-13 13:45:48 +00:00
2018-04-04 15:39:48 +00:00
Use TypeScript for best in class instellisense.
2019-04-11 16:50:43 +00:00
### What is smartuniverse all about?
2019-04-11 16:31:21 +00:00
2019-04-11 16:32:36 +00:00
Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
2019-04-11 16:31:21 +00:00
2019-04-11 16:59:45 +00:00
### Server side
2019-04-22 22:28:57 +00:00
2019-04-11 16:59:45 +00:00
every universe has a server that manages messages.
Think Kafka, but without Kafka.
2019-04-11 16:50:43 +00:00
```typescript
import * as smartuniverse from '@pushrocks/smartuniverse';
const myUniverse = new smartuniverse.Universe({
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
});
// create as many channels as you like
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
myUniverse.start(8765); // start the server and provide the port on which to listen on
```
2019-04-11 16:59:45 +00:00
### Client side
2019-04-22 22:28:57 +00:00
2019-04-11 16:59:45 +00:00
All your microservices represents clients in the universe that may talk to each other using the universe server.
2019-01-31 01:52:18 +00:00
For further information read the linked docs at the top of this readme.
2018-04-04 15:39:48 +00:00
2019-01-31 01:52:18 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-09-01 15:04:25 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
2018-04-04 15:39:48 +00:00
2019-09-01 15:04:25 +00:00
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)