https://github.com/leticea/notifications-service
Projeto do evento do Ignite Lab da Rocketseat desenvolvido com Node.js, bem arquitetada, com testes, inversão de dependências, tudo bem bacana e completo.
https://github.com/leticea/notifications-service
insomnia jest nestjs nodejs npm typescript
Last synced: 4 months ago
JSON representation
Projeto do evento do Ignite Lab da Rocketseat desenvolvido com Node.js, bem arquitetada, com testes, inversão de dependências, tudo bem bacana e completo.
- Host: GitHub
- URL: https://github.com/leticea/notifications-service
- Owner: leticea
- Created: 2022-12-13T17:45:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T13:05:08.000Z (almost 3 years ago)
- Last Synced: 2025-04-03T15:46:17.455Z (over 1 year ago)
- Topics: insomnia, jest, nestjs, nodejs, npm, typescript
- Language: TypeScript
- Homepage:
- Size: 332 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Tecnologias |
Projeto |
Como rodar |
Como contribuir
# Notifications Service
## 🚀 Tecnologias
Esse projeto foi desenvolvido com as seguintes tecnologias:
- [Nodejs](https://nodejs.org/en/) - v18.12.1
- [Nestjs](https://nestjs.com/) - 9.1.5
- [Npm](https://www.npmjs.com/) - 8.19.2
- [Insomnia](https://docs.insomnia.rest/insomnia/get-started)
## 💻 Projeto
Projeto desenvolvido com Node.js de uma API de notificações.
Evento do Ignite Lab na plataforma da [Rocketseat](https://www.rocketseat.com.br/).
## 🚀 Como Rodar
- Clone o projeto.
- Entre na pasta do projeto e rode 'npm install' (use 'yarn install' se for essa a sua configuração).
- npx prisma migrate dev.
- npx prisma studio (para visualizar a página do banco de dados).
- npm run start:dev (roda o projeto na porta localhost:3000).
- npm run test (para rodar os testes).
## 👩🏿💻 Rotas
- **`POST /notifications`**: Rota para criação de notificações:
Envia:
Retorna:
- **`GET /notifications/from/:recipientId`**: Rota para mostrar as notificações de um mesmo usuário:
Retorna:
- **`GET /notifications/count/from/:recipientId`**: Rota para mostrar a contagem de notificações de um mesmo usuário:
Retorna:
- **`PATCH /notifications/:id/cancel`**: Rota para cancelar notificações.
- **`PATCH /notifications/:id/read`**: Rota para mostrar uma notificação como lida.
- **`PATCH /notifications/:id/unread`**: Rota para mostrar uma notificação como não lida.
## 🤔 Como contribuir
- Faça um fork desse repositório;
- Cria uma branch com a sua feature: `git checkout -b minha-feature`;
- Faça commit das suas alterações: `git commit -m 'feat: Minha nova feature'`;
- Faça push para a sua branch: `git push origin minha-feature`.
Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
## 📝 Licença
Esse projeto está sob a licença MIT.