npm package: @miladev/realtime.io
Description: NestJS module for realtime communication and logging
Author: Tsiresy Milà
Latest version: 0.0.3

<p align="center">
  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
</p>

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
    <p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
</p>
  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->

## Description

[Nest](https://github.com/nestjs/nest) framework TypeScript realtime broker repository.

## Get started

First create account in [Realtime Broker website](https://realtimeio.sutchapp.com) and get REALTIMEIO_SERVER, use SERVER_URL as https://realtimeio.sutchapp.com

## Installation

```bash
$ yarn add @miladev/realtime.io --save
```

## Config app in app.module.ts

```ts
RealtimeIOModule.forRoot({
  REALTIMEIO_SERVER: '[REALTIMEIO_SERVER]',
  REALTIMEIO_SERVER: '[REALTIMEIO_SERVER]',
});
```

## Config app async mode in app.module.ts

```ts
 RealtimeIOModule.forRootAsync({
    imports: [ConfigModule],
    useFactory: (config: ConfigService) =>({ 
      REALTIMEIO_KEY: config.get('REALTIMEIO_SERVER')
      REALTIMEIO_SERVER: config.get('REALTIMEIO_SERVER')
    }),
    inject: [ConfigService]
  }
 )
```

in .env file

```env
REALTIMEIO_SERVER=[apikey]
REALTIMEIO_SERVER=https://realtimeio.sutchapp.com
```

## Stay in touch

- Author - [Tsiresy Milà](https://tsiresymila.sutchapp.com)

## License

Nest is [MIT licensed](LICENSE).