Esta é uma API feita em NestJS e projetada para atender os serviços do projeto Morada APP. Sendo assim, buscamos facilitar a vida dos moradores de condomínio e dos desenvolvedores responsáveis por integrar nosso código em seus sistemas.
Adiante, nossos servidores back-end devem contar com as seguintes dependências e ferramentas para que esteja em perfeito funcionamento:
- Mailtrap: em ambiente de desenvolvimento, usamos o Mailtrap para realizar o envio de emails dentro da plataforma;
- Postgres: banco de dados SQL do projeto;
- PNPM: para gerenciar nossas dependências estamos usando o Performant Node Package Manager (PNPM). Por quê? A resposta é simples, o pnpm é capaz de gerar links simbólicos de cada dependência utilizada no projeto, como consequência, o mesmo é capaz de reutilizar as bibliotecas que já existem em uma máquina, reduzindo de maneira significativa o espaço consumido pelo nosso sistema;
- Docker: o Docker é uma plataforma de virtualização de contêineres que permite isolar e empacotar aplicativos e seus ambientes de execução em contêineres, facilitando a preparação do ambiente do sistema e viabilizando o deploy da aplicação em inúmeras provedoras de nuvem. Sendo assim, basta executar os comandos que serão passados logo mais, e você já será capaz de possuir todos os servidores prontos para execução rapidamente. Matando assim, a necessidade de se passar horas na frente do computador configurando serviço a serviço para rodar na sua máquina;
- Docker Compose: é um orquestrador de contêineres do Docker, responsável por manter o sistema funcionando em conjunto, podendo configurar redes internas, mapear as portas de cada serviço e entre outras inúmeras funcionalidades essenciais;
- Zipkin: é um servidor dedicado a monitorar a perfomance da aplicação em ambiente de desenvolvimento por meio de traces, atuando na RegistryApi em conjunto com o OpenTelemetry
-
Docker
-
Docker Compose
-
PNPM: execute
npm i pnpm -g -
Mailtrap:
- Crie uma conta na plataforma por aqui.
- Acesse o menu da lateral a esquerda
- Entre em Email Testing > Inboxes > [Seu usuário]
- Copie e cole o arquivo .env.example em .env
- Ao lado direito, na opção 'Integrations', troque para o nodemailer
- Copie e cole as credenciais no .env para visualizar os dados
- Insira em HOST_SENDER o valor 'sandbox.smtp.mailtrap.io'
- Insira em HOST_PORT_SENDER o valor 2525
- Coloque qualquer nome em NAME_SENDER
- Insira auth.user em EMAIL_SENDER
- Insira auth.pass em PASS_SENDER
Primeiramente, clone o .env.example para '.env' e preencha as variáveis com os seus respectivos valores.
Feito isso, você pode optar por utilizar o sistema otimizado para a execução local com o docker-compose.yml que está dentro do diretório /example ou então clonar o /docker-compose.example.yml para usar o back-end em ambiente dedicado ao desenvolvimento do ponto de vista de um programador back-end:
docker compose -f <docker compose de sua preferência> up
Feito isso, se você tiver optado por utilizar o diretório /example, o tutorial acaba aqui. No entanto, se estiver usando o outro ambiente, adentre na aplicação usando o bash para entrar na instância app (o contêiner em NodeJS + NestJS):
docker compose exec app bash
Dentro do contêiner, execute as migrations do TypeOrm:
pnpm migrate:run
Agora, realize o login na sua conta do firebase DENTRO DO CONTÊINER:
firebase login --no-localhost
Logo em seguida, instale os emuladores requisitados para um bom funcionamento da aplicação:
firebase init emulators
Se a instalação ocorreu com êxito, abra outro terminal e FORA DO CONTÊINER execute o comando abaixo. Por quê? Ele vai definir os hooks do git necessários para que você consiga automatizar processos de lint, formatação e testes locais toda vez que fazer commit:
pnpm set-hooks
Pronto, agora execute somente pnpm commit sempre que quiser salvar suas alterações no repositório. No mais, basta verificar quais comandos estão disponíveis dentro do package.json.