@shindiogo/api

Este boilerplate servirá de Core a todas os serviços em NodeJS utilizando framework NESTJS

Installation

Para implementar este código corra o seguinte comando num projeto NestJS

npm install -s @shindiogo/api

Variáveis ambiente

Authentication

USE_AUTH=false
AUTH_SERVER=https://identity.humanbox.pt
AUTH_JWKS_URL=https://identity.humanbox.pt/.well-known/openid-configuration/jwks
AUTH_CLIENT_ID=humanboxapp
AUTH_EXPIRATION_TIME=3600
AUTH_WHITELIST=::1

TypeORM

USE_TYPEORM=true
*TYPEORM_TYPE=mariadb
*TYPEORM_HOST=xxx.humanbox.pt
*TYPEORM_USERNAME=root
*TYPEORM_PASSWORD=x
*TYPEORM_NAME=boilerplate
*TYPEORM_PORT=0000
TYPEORM_LOGGING=true
TYPEORM_MIGRATIONS_RUN=false
TYPEORM_MIGRATIONS=lib/app/migrations/**/*{.ts,.js}
TYPEORM_MIGRATIONSDIR=dist/app/migrations

GraphQL

USE_GRAPHQL=true
*GRAPHQL_PLAYGROUND=true
*GRAPHQL_DEBUG=true
*GRAPHQL_SCHEMA_DIR=dist/app/schema/schema.gql

Logger

USE_LOGGER=true
*LOGGER_CONSOLE=true
*LOGGER_FILE=true
*LOGGER_SUMOLOGIC=false
*LOGGER_SENTRY=true
*LOGGER_SENTRY_LEVEL=warn
*LOGGER_ENDPOINT=https://3df09....002fc425d588f@sentry.io/1870181

Bull Queue

USE_BULL=true
BULL_QUEUE=
BULL_REDIS_HOST=
BULL_REDIS_PORT=
BULL_REDIS_PASSWORD=

Minio

USE_MINIO=true
MINIO_ENDPOINT=storage.humanbox.pt
MINIO_PORT=443
MINIO_SSL=true
MINIO_ACCESSKEY=xxx
MINIO_SECRETKEY=xx

Swagger

USE_SWAGGER=true