Nexti-bff-types NPM

💻 Sobre o projeto

O módulo BFF types tem como responsabilidade exportar toda a tipagem do bff da Nexti.

⚙️ Arquitetura de módulos

Types: os arquivos dentro da pasta types, correspondem a tipagem de todos os parâmetros de requisição e retorno das APIs do BFF.

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Realizando o build da aplicação

# Clone este repositório
$ git clone git@github.com:nexti-frontend/bff.git
# Vá para a pasta @npm-driver-service-dashboard no terminal/cmd
$ cd services/dashboard/@bff-types
# Instale as dependências
$ yarn
# Realize o build do pacote
$ yarn build
# Publique o pacote na npm store
$ yarn publish
# O pacote ficará disponível na npm store com o alias @nexti/bff-types

💡Para realizar a publicação, utilizamos a ferramenta codeartifact da AWS, que tem a responsabilidade de publicar o pacote. Sendo um pacote privado, é necessário registrar o .nmprc no projeto que estiver consumindo a biblioteca. Para tal, é necessário apenas copiar o arquivo .npmrc do presente projeto, para o projeto que consumirá o pacote.