Algoan NestJS connector boilerplate

A simple NestJS boilerplate written using nestjs to connect your service.

Description

Nest framework TypeScript starter repository for Algoan connectors.

Application Structure

• config/: stores all configurations for the application. It uses node-config-ts to generate a type definition of the default.json file.
• src/algoan/: Algoan module getting your service accounts. It uses the @algoan/rest library.
• src/hooks/: Entry point for your RestHook called by Algoan. It handles events you've subscribed to.
• test/: contains e2e tests.

Code Style

This project uses ESLint to analyze the TypeScript code. Commit are linted too thanks to commitlint and the conventional commit format.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

If you need credentials for your service, please contact [email protected].