Qrispy E-sim Providers NestJS Package

This package is developed by Qrispy and is designed for use in Qrispy E-sim developments.

Installation and Usage

Build the Package

To build the package, run the following command in the root directory:

npm run build

Local Development

If you are developing locally and want to test the package in another project, follow these steps:

1. In the root directory of the package, run:

   npm link

2. Go to the root directory of your main project and run:

   npm link qrispy-esim-providers

Publishing the Package

When you are ready to release the package, follow these steps:

1. Ensure you are authenticated with npm. Our npm username/email is [email protected].

2. In the root directory of the package, run:

   npm publish

Note: Authentication with npm is required before you can publish the package.

Usage Example

Here's a basic example of how to import and use the EsimProvidersModule in another NestJS project:

import { Module } from '@nestjs/common';
import { EsimProvidersModule } from 'qrispy-esim-providers';

@Module({
  imports: [
    EsimProvidersModule.forRoot({
      providerName: 'TELNA', //Currently we only have one provider TELNA
      region: 'eu-west-2', //AWS infrastructure region
    }),
  ],
})
export class AppModule {}

Telna is supported as provider by now, please contact further information. AWS regions is necessary because all private keys are stored at AWS Secret Manager.

License

MIT License

Contact

For further information, please contact [email protected].

This `README.md` file includes:
- A brief description of the package and its purpose.
- Instructions for building the package.
- Steps for linking the package locally for development.
- Instructions for publishing the package to npm.
- An example of how to use the package in a NestJS project.
- License information.
- Contact information for further assistance.