guide application layers - wwwsolutions/nestjs-starter-kit GitHub Wiki

Guide - Integration

Implement an Integration

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

Create a Domain

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

> apps/api/src/main.ts

> libs/api/integrations

  • generate new integration lib

> libs/api/config/app/src/lib/constants/api.constants.ts

  • edit ApiIntegrationType enum

> .env.*

  • edit API_TYPE
  • edit API_INTEGRATION_TYPE

> validation files

  • set API_TYPE
  • set API_INTEGRATION_TYPE

> .env files

Generate library
nx generate xxx
Install Dependencies
npm install xxx
Usage
nx run xxx

libs/api/config/app

Edit > project.json

libs/api/config/app/src

Edit > index.ts

libs/api/config/app/src/lib

Edit > api-config-app.module.ts
Create > constants.ts
Create > validation.schema.ts

libs/api/config/app/src/lib/configs

Create > environment.configuration.ts
Create > app.configuration.ts
Create > cache.configuration.ts
Create > winston.configuration.ts

> api-config-features

Generate library
nx generate xxx
Install Dependencies
npm install xxx
Usage
nx run xxx

libs/api/config/features

Edit > project.json

libs/api/config/features/src

Edit > index.ts

libs/api/config/features/src/lib

Edit > api-config-features.module.ts
Create > features-config.registration.ts
Create > integration-config.registration.ts
Create > validation.schema.ts

> api-config-codegen

libs/api/config/codegen

Generate library
nx generate xxx
Install Dependencies
npm install xxx
Usage
nx run xxx

> api-config-docker

libs/api/config/docker

Generate library
nx generate xxx
Install Dependencies
npm install xxx
Usage
nx run xxx

Core Layer

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

> api-core

libs/api/core

Generate library
nx generate xxx
Install Dependencies
npm install xxx
Usage
nx run xxx

Data Layer

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

Domain/Business-logic Layer

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

Integration Layer

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

Documentation version 0.0.1

⚠️ **GitHub.com Fallback** ⚠️