Serviço de Notificação

🖥️ Projeto   |    🚀 Tecnologias   |    👨‍💻 Execução   |    ⚙ Testes   |    📄 Documentação   |    📝 License   |   

💻 Projeto

Serviço de Notificação desenvolvido durante o Ignite Lab da Rocketseat em 2022.

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

👨‍💻 Execução

## 1. Clone o projeto
git clone https://github.com/elanonc/notifications-service

## 2. Entre no diretório do projeto
cd notifications-service

## 3. Instale as dependências
npm install

## 4. Inicie o servidor
npm run start:dev

## 5. Execute as migrations
npx prisma migrate dev

⚙ Testes

## 1. Execute o seguinte comando
  npm run test

📄 Documentação

Envia uma notificação

  POST /notifications/

Parâmetro	Tipo	Descrição
recipientId	string	Obrigatório. O ID do recebedor da notificação.
content	string	Obrigatório. O conteúdo da notificação.
category	string	Obrigatório. A categoria da notificação.

Marca notificação como lida

  PATCH /notifications/:id/unread

Parâmetro	Tipo	Descrição
id	string	Obrigatório. O ID da notificação.

Marca uma notificação como não lida

  PATCH /notifications/:id/read

Parâmetro	Tipo	Descrição
id	string	Obrigatório. O ID da notificação.

Cancela uma notificação enviada

  PATCH /notifications/:id/cancel

Parâmetro	Tipo	Descrição
id	string	Obrigatório. O ID da notificação.

Retorna as notificações enviadas para um recebedor

  GET /notifications/from/:recipientId

Parâmetro	Tipo	Descrição
recipientId	string	Obrigatório. O ID do recebedor da notificação.

Retorna a quantidade de notificações de um único recebedor

  GET /notifications/count/from/:recipientId

Parâmetro	Tipo	Descrição
recipientId	string	Obrigatório. O ID do recebedor da notificação.

📝 License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---