Sasai-bff-common NPM

Sasai BFF Common Package - Introduction

The sasai-bff-common package is a collection of common utility modules for use in the Sasai microservices ecosystem. This package provides various functionality to assist in building microservices, with the initial focus on authentication and security. It is designed to be used internally by Sasai's microservices.

Version

Current Version: 1.0.0
Release Date: October 23, 2023

Installation

You can install this package via npm: npm install sasai-bff-common

Modules and Methods

In this section, you'll find an overview of the modules included in the sasai-bff-common package, along with their primary purposes and the methods they offer.

Secure Module Purpose: The secure module provides methods for authentication and security-related tasks.

Required Environment Variables

The sasai-bff-common package requires certain environment variables to be defined in the project that uses this package. These environment variables are used for configuration and proper functioning of the package. Please make sure to set the following environment variables in your project:

REDIS_DB_URL: The URL of your Redis database. REDIS_DB_USER: The username for connecting to the Redis database. REDIS_DB_PASSWORD: The password for connecting to the Redis database. You must define and set these environment variables in your project's configuration or environment management system.