# pip-services-runtime-node

> Microservices runtime framework for Pip.Services in Node.js

Latest version **1.0.5** (published 2016-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install pip-services-runtime-node
pnpm add pip-services-runtime-node
yarn add pip-services-runtime-node
bun add pip-services-runtime-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-08-06 |
| First published | 2016-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6.14 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Digital Living Software Corp. |
| Maintainers | seroukhov |
| Keywords | pip.services, microservice, runtime, framework |

## Links

- npm: https://www.npmjs.com/package/pip-services-runtime-node
- Repository: https://github.com/pip-services/pip-services-runtime-node
- Homepage: https://github.com/pip-services/pip-services-runtime-node#readme
- Issues: https://github.com/pip-services/pip-services-runtime-node/issues
- npm.io page: https://npm.io/package/pip-services-runtime-node

## Dependencies (5)

- [async](https://npm.io/package/async.md) *
- [lodash](https://npm.io/package/lodash.md) *
- [js-yaml](https://npm.io/package/js-yaml.md) *
- [shortid](https://npm.io/package/shortid.md) *
- [node-uuid](https://npm.io/package/node-uuid.md) *

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2016-08-06
- 1.0.4 — 2016-08-06
- 0.0.1 — 2016-06-15
- 1.0.2 — 2016-06-05
- 1.0.1 — 2016-06-03
- 1.0.0 — 2016-06-02

## README

# <img src="https://github.com/pip-services/pip-services/raw/master/design/Logo.png" alt="Pip.Services Logo" style="max-width:30%"> <br/> Microservices runtime for Node.js

This framework is a part of [Pip.Services](https://github.com/pip-services/pip-services) project.
It provides foundation for **composable microservices** using Node.js technology stack.
Each microservice is constructed from components created following 
[user-defined configuration](https://github.com/pip-services/pip-services/blob/master/usage/Configuration.md). 

The conceptual architecture of the framework is presented on the diagram below. For more details , please, refer to 
[Pip.Services Reference Architecture](https://github.com/pip-services/pip-services/raw/master/design/Architecture.md) document.

<div style="border: 1px solid #ccc">
  <img src="https://github.com/pip-services/pip-services-runtime-node/raw/master/doc/Overview.png" alt="Runtime Architecture" style="display:block;">
</div>

The main goal of the framework is to enable flexible microservice structure that can adjust based on the
user requirements. It allows to run microservices on virtually any platform, with any infrastructural services and storages
while protecting core business logic from rework due to changes in technologies and deployment configurations.

All functionality of the runtime is split into several packages:

<div style="border: 1px solid #ccc">
  <img src="https://github.com/pip-services/pip-services-runtime-node/raw/master/doc/Packages.png" alt="Runtime Packages" style="display:block;">
</div>

- **Core** - key microservice abstractions and components
- **Portability** - cross-language and cross-platform abstractions
- **Errors** - microservice error definitions
- **Config** - microservice configuration
- **Data** - data handling patterns
- **Validation** - data validation
- **Commands** - command pattern
- **Build** - microservice component factories and builder
- **Run** - microservice container, runners and wrappers
- **Discovery** - discovery components: Null, Memory, File, REST, Etcd, Consul, ...
- **Boot** - bootstrap configuration readers: File, REST, Etcd, Consul, ...
- **Logs** - logger components: Null, Console, REST, Logstash, ...
- **Counters** - performance counters: Null, Log, REST, ...
- **Cache** - transient cache components: Null, Memory, Memcached, Redis, ...
- **Persistence** - abstract persistent components: Memory, File, MongoDB, Cassandra, MySQL, SQL Server, ...
- **Logic** - abstract business logic components: controllers and decorators
- **Clients** - abstract client components: Direct, REST, Seneca, Lambda, Thrift, ...
- **Services** - abstact service components: REST, Seneca, Thrift, ...
- **Addons** - abstract and specific addons: Seneca, Random Shutdown, Status, Node Registry, ... 

Quick Links:

* [Downloads](doc/Downloads.md)
* [Reference Architecture](https://github.com/pip-services/pip-services/blob/master/design/ReferenceArchitecture.md)
* [API Reference](http://htmlpreview.github.io/?https://github.com/pip-services/pip-services-runtime-node/blob/master/doc/api/index.html)
* [Configuration](https://github.com/pip-services/pip-services/blob/master/usage/Configuration.md)
* [Building and Testing](doc/Development.md)
* [Contributing](doc/Development.md/#contrib)

## Acknowledgements

The runtime framework is created and maintained by several individuals:

- **Sergey Seroukhov** - architecture and implementation
- **Volodymyr Tkachenko** - seneca components

---
_Source: https://npm.io/package/pip-services-runtime-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
