Skip to content

Microserviço Node feito com arquitetura API REST, usando framework NestJS e Typescript.

License

Notifications You must be signed in to change notification settings

franklindrw/push-service

Repository files navigation

notifications-banner

API REST - Notifications


🪧 Vitrine.Dev https://cursos.alura.com.br/vitrinedev/franklindrw
✨ Nome API REST - Notifications
🏷️ Tecnologias Node, NestJs, Typescript, Prisma, mySql, Jest
🚀 URL
🔥 Desafio Microserviço Node feito com arquitetura API REST, usando framework NestJS e Typescript.



🧭 Índice



🔎 Sobre o Projeto

O Microserviço Notifications tem como objetivo servir aplicativos com requisições HTTP para enviar e atualizar os status das mensagens criadas pelo próprio sistema, assim mantendo um histórico de cada notificação enviada para os usuários.

Arquitetura

Sua arquitetura foi seguindo o framework NestJS, com esse framework podemos criar uma API Rest de forma rápida pois ao iniciar o projeto com NestJs, o mesmo já nos fornece um ambiente pré-montado para trabalhar, assim se preocupando em apenas criar as classes da aplicação e suas funções.

image

O framework já trás como padrão uma main já configurada, os Modulos e o Controle com uma rota de exemplo, com o mesmo também é possível criar novas rotas com poucos comandos no cli, já que o framework é baseado no Angular

Prisma

Com o ORM Prisma conseguimos criar, editar tabelas no banco de dados sem precisar escrever SQL diretamente no banco, a ideia do ORM é facilitar na hora do desenvolvimento, onde podemos configurar o arquivo de schema para criar a tabela e automaticamente criar os comando de SQL e executar no banco conectado.

image

E nos Models da aplicação conseguimos tratar os dados de forma simples usando um json e funções do próprio Prisma para inserir e/ou alterar os dados

image

Jest

Já o Jest é um framework voltado para testes unitários, com ele é possível criar testes da aplicação enquanto é desenvolvida, assim evitando que conforme o crescimento do projeto algum componente fique para trás com algum bug, pois o framework quando iniciado faz o teste de todos os specs criados durante a aplicação de forma rápida, poupando tempo do desenvolvedor testar todos os componentes ao criar novas funções.

image image

image

🔨 Construído com


📥 Instalação

Requisitos

É necessário ter instalado Node.js, caso não tenha pode baixar Clicando aqui!

API

  1. Dentro da pasta do projeto use o comando abaixo:

      npm i
    

    e aguarde instalar todas as bibliotecas necessárias para rodar o projeto.

  2. Após gerar os arquivos você pode testar a aplicação na máquina usando o comando:

      npm run start:dev
    

    em seguida irá iniciar o projeto no endereço: http://localhost:3000

  3. Caso queira instalar em um servidor de produção pode compilar a aplicação usando o comando:

      npm run build
    

    em seguida copie a pasta dist gerada dentro da aplicação para o servidor desejado, navegue até dentro da pasta onde está a pasta build, e com Node instalado e use o comando abaixo para rodar o build:

      node ./dist/src/main.js
    

🖊 Autor

Foto do Autor
Franklin Campos

Feito por Franklin Campos 👋🏻
Entre em contato!

📋 Licença

Copyright 2023 © Franklin Campos
This project is MIT licensed.

About

Microserviço Node feito com arquitetura API REST, usando framework NestJS e Typescript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published