1.0.10 • Published 2 years ago

@maximiliana/mxa-shared v1.0.10

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@maximiliana/mxa-shared

mxa-shared is the shared library of Maximiliana's backend. It provides basic features shared accross different microservices. This package should me minimal and contain only low-level features which are really worthy sharing. This package is intended to be used with the NestJS framework.

Included modules

The current version of the package includes following modules.

  • time-series-database. Basic low-level write functionality for InfluxDB.
  • secrets. Access to config secrets (e.g. DB credentials). Supports both local secrets (via env vars) and distributed secrets (using GCP Secret Manager)
  • notifications. Basic low-level notification functionality to send messages using Slack API.

Usage

For the moment, all the included modules should be configured as global modules. Thus, they should be imported at app.module.ts using the forRoot(...) or forRootAsync(...) method.

Distribution

This package will be published at NPM. The microservices using it will import it as regular NPM package. For local development, Verdaccio will be used. The main reason of this is being able to build the containers of the microservices using this package in environments where a local copy of the source code is not available (e.g. during deployment via Github Actions).