A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Introdução

Bem-vindo ao BFF (Backend For Frontend) desenvolvido para atuar como intermediário entre o frontend e o servidor do ServerRest. Este projeto foi desenvolvido utilizando o Nest.js e segue uma arquitetura baseada em princípios Clean Architecture e Hexagonal Architecture.

Objetivo

O objetivo deste BFF é facilitar a comunicação entre o frontend e o servidor do ServerRest, fornecendo endpoints específicos e adaptadores necessários para atender às necessidades do frontend.

Tecnologias Utilizadas

• Nest.js
• Axios
• Swagger

Configuração

Variáveis de Ambiente Certifique-se de configurar as variáveis de ambiente necessárias para a execução do projeto. Consulte o arquivo .env.example para obter um exemplo.

# .env.example
PORT=3000
PROVIDER_SERVER_REST_BASE_URL=https://serverest.dev

Funcionalidades Concluídas

1 - Cadastro de Usuários

• Endpoint para criar um usuário.
• Utiliza o serviço do ServerRest para persistência.

2 - Login de Usuários

• Endpoint para realizar login.
• Retorna um token de autorização.

3 - Testes com PactumJS

• pactumJS.spec.ts

Funcionalidades a Concluir

1 - Melhorias no Swagger

• Expandir a documentação Swagger para incluir exemplos de payloads.

2 - Testes Automatizados

• Implementar testes unitários e de integração para garantir robustez.
• Implementar logica de cleanup no pactumJS.

3 - Tratamento de Erros

• Melhorar o tratamento de erros, fornecendo mensagens de erro mais detalhadas.

4 - Segurança

• Implementar práticas de segurança adicionais, como validação de entrada e autenticação.

5 - Integração Contínua

• Configurar pipelines de integração contínua para automatizar o processo de construção e teste.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

O servidor estará em execução em http://localhost:3000.

O Swagger estará disponivel em http://localhost:3000/api.

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e
# Teste do pactumJs esta aqui

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.