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

MiniService-notification

Projeto "MiniService-notification" - Um serviço de notifications, com alguns campos (contéudo, category, ID), usando alguns principios de arquitetura construido com Nest e Prisma.

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• clonar o projeto com para a sua máquina local. (git clone https://github.com/Thiago-Mota-Santos/Miniservice-notification.git)
• verificar de ter o node.js instalado, juntamente com o gerenciador de pacotes (npm ou yarn)

🚀 Instalando

Para instalar o (MiniService-notification) , siga estas etapas:

Windows:

clonar o projeto com para a sua máquina local. (git clone https://github.com/Thiago-Mota-Santos/Miniservice-notification.git)
cd Miniservice-notification (acessar a pasta do projeto)
npm install (para instalar as dependências do node.js na sua máquina)
npm run start:dev (iniciar o projeto)
npx prisma studio (para visualizar na interface do prisma as tabelas, dentro do navegador)

 

☕ Usando

Para usar (MiniService-notification), siga estas etapas:

• Utilize alguma ferramenta para fazer as operações HTTP, no caso dessa aplicação : (get, post, patch)
• Os casos de uso (use-case) para essa aplicação se definem em :
  • Criar uma notificação;
  • ler uma notificação;
  • Desmarcar uma notificação como lida;
  • Cancelar uma notificação;
  • Contar as notificações;
  • Buscar uma notificação por ID.
• Use algum serviço para mandar as requisições (usei o Insomnia como exemplo):

  • Criar uma notificação - metódo GET - /notifications - enviar um json com envolvendo a estrutura ("content", "category", "recipientId"), { "content: "content example", "category" "category example", "recipientId" "uuid", } Ps.:: "RecipientId" precisa de um ID único, em softwares como insomnia há como criar um ID único universal

  • ler uma notificação - metódo PATCH - /notifications/o número do ID da notificação/read (O id da notificação será retornada no json quando você criar uma notificação, use-a se quiser)

  • Desmarcar uma notificação como lida - metódo PATCH - /notifications/o número do ID da notificação/unread;

  • Cancelar uma notifificação - metódo PATCH - /notifications/o número do ID da notificação/cancel;

  • Contar as notificações - metódo GET - /notifications/count/from/o número do ID da notificação/;

  • Buscar uma notificação como ID - metódo GET - notifications/from/o número do RecipientID da notificação (Quando uma notificação é criada, também há no JSON um 'recipientId' que se diferente do ID, use-o para retornar uma notificação).

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# 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.