# openair-dpi-kinesis

> Kinesis Dpi microservice

Latest version **1.3.0** (published 2018-08-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install openair-dpi-kinesis
pnpm add openair-dpi-kinesis
yarn add openair-dpi-kinesis
bun add openair-dpi-kinesis
```

## 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.3.0 |
| Published | 2018-08-27 |
| First published | 2018-08-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 23 |
| Unpacked size | 99.7 KB |
| Known vulnerabilities | 0 (+14 in 4 direct dependencies) |
| Install scripts | no |
| Author | Anahi |
| Maintainers | anahiem |
| Keywords | everymundo, microservice |

## Links

- npm: https://www.npmjs.com/package/openair-dpi-kinesis
- Repository: https://github.com/EveryMundo/openair-dpi-kinesis
- Homepage: https://github.com/EveryMundo/openair-dpi-kinesis#readme
- Issues: https://github.com/EveryMundo/openair-dpi-kinesis/issues
- npm.io page: https://npm.io/package/openair-dpi-kinesis

## Dependencies (23)

- [ip](https://npm.io/package/ip.md) ^1.1.5
- [pino](https://npm.io/package/pino.md) ^5.4.0
- [dotenv](https://npm.io/package/dotenv.md) ^5.0.1
- [ghooks](https://npm.io/package/ghooks.md) ^2.0.4
- [amqplib](https://npm.io/package/amqplib.md) ^0.5.2
- [aws-kcl](https://npm.io/package/aws-kcl.md) ^0.7.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.302.0
- [em-logr](https://npm.io/package/em-logr.md) ^1.2.0
- [fastify](https://npm.io/package/fastify.md) ^0.43.0
- [kinesis](https://npm.io/package/kinesis.md) ^1.2.2
- [mongoose](https://npm.io/package/mongoose.md) ^5.2.10
- [microtime](https://npm.io/package/microtime.md) ^2.1.8
- [resilient](https://npm.io/package/resilient.md) ^0.4.0
- [pino-pretty](https://npm.io/package/pino-pretty.md) ^2.0.1
- [milliseconds](https://npm.io/package/milliseconds.md) ^1.0.3
- [fastify-helmet](https://npm.io/package/fastify-helmet.md) ^1.0.3
- [fastify-swagger](https://npm.io/package/fastify-swagger.md) ^0.3.2
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2
- [@everymundo/runner](https://npm.io/package/@everymundo/runner.md) ^1.1.0
- [@everymundo/em-eureka](https://npm.io/package/@everymundo/em-eureka.md) ^1.7.2
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5
- [@everymundo/global-root-dir](https://npm.io/package/@everymundo/global-root-dir.md) ^1.1.0
- [@everymundo/generate-microservice-name](https://npm.io/package/@everymundo/generate-microservice-name.md) ^1.1.1

## Recent versions

- 1.3.0 (latest) — 2018-08-27
- 1.0.1 — 2018-08-13
- 1.0.0 — 2018-08-13

## README

# openair-dpi-kinesis project
This repository contains a Node.js project under microservice architecture.
The main functionality is to receive Aws kinesis stream data and send it to the 
tenant DPI Mongo databases.

## Contributors
* Daniel Santana (Main template creator) <daniel@everymundo.com>
* Anahi Martinez <anahi@everymundo.com>
* Vincent Medina <vincent@everymundo.com>


## Running the project

 - Make sure to set up an AWS profile for your credentials in your .env file with the following at the root of the project.
    ```sh
    AWS_PROFILE='kinesis'
    AWS_REGION='region'
    AWS_KINESIS_STREAM='streamName'
    ```
  - Also configure the credentials in your local environment: 
    ```sh
    [kinesis]
    aws_access_key_id = SOME_KEY_ID
    aws_secret_access_key = SOME_SUPER_SECRET_ACCESS_KEY
    ```
  > To learn how to create profiles see [Using Profiles with the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html)


### Run Eureka server
```sh
  npm run eureka
```
### Run project
```sh
  npm run local
```

### Check coverage
```sh
  npm run cover
```

## Version History

#### 1.1.0 

Stream-sourced documents now populate tenant databases (Mongo connection declared in env vars).

#### 1.0.0

Initial project structure, including Kinesis stream connection and document recovery.

---
_Source: https://npm.io/package/openair-dpi-kinesis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
