https://github.com/amaui-org/amaui-redis

Redis utils
https://github.com/amaui-org/amaui-redis

amaui api back-end backend js nodejs redis utils

Last synced: about 2 months ago
JSON representation

Redis utils

• Host: GitHub
• URL: https://github.com/amaui-org/amaui-redis
• Owner: amaui-org
• License: mit
• Created: 2024-01-21T11:22:53.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-04-13T13:36:21.000Z (9 months ago)
• Last Synced: 2024-09-17T11:43:32.843Z (4 months ago)
• Topics: amaui, api, back-end, backend, js, nodejs, redis, utils
• Language: JavaScript
• Homepage: https://docs.amaui.me/library/redis
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

    

  



amaui Redis




  Redis








  MIT license    

  Production ready    

  100% test cov    

  Nodejs





    Very simple code    

    Modern code    

    Junior friendly    

    Typescript    

    Made with :yellow_heart:






## Getting started

### Add

```sh

  yarn add @amaui/redis

```

Add `redis` peer dependency.

```sh

  yarn add redis

```

### Use

```javascript

  import AmauiRedis from '@amaui/redis';

  // Make if you wanna a config file and

  // inside of it add all the process.env related props

  import Config from './config';

  // Make a new amqp instance

  const amauiRedis = new AmauiRedis({

    uri: Config.amqp.redis.uri

  });

  // Await for a client connection

  await amauiRedis.client;

  // Send to a queue

  await amauiRedis.publish('a', 'a'); 

```

### Dev

Install

```sh

  yarn

```

Test

```sh

  yarn test

```

One time local setup

Install docker and docker-compose

  - https://docs.docker.com/get-docker

  - https://docs.docker.com/compose/install

Make docker containers

```sh

  yarn docker

```

### Prod

Build

```sh

  yarn build

```