wkarts/webhookmultidb repository overview

# Webhook MultiDB

Webhook MultiDB é um sistema escalável de gerenciamento de webhooks com suporte a múltiplos bancos de dados.
Ele permite gerenciar, criar e executar webhooks de forma eficiente, com suporte a filas de processamento usando RabbitMQ,
integração com Redis ou MongoDB para armazenamento dinâmico, e autenticação JWT para garantir a segurança.

## Funcionalidades

- Criação e gerenciamento de webhooks.
- Suporte a múltiplos bancos de dados, como PostgreSQL e MySQL, para clientes diferentes.
- Execução assíncrona de webhooks com RabbitMQ.
- Monitoramento de mudanças em bancos de dados PostgreSQL (usando `LISTEN/NOTIFY`) e MySQL (usando polling).
- Armazenamento flexível utilizando Redis ou MongoDB, configurável via variáveis de ambiente.
- Autenticação JWT para proteger a API.
- Logs estruturados com Winston.
- Monitoramento com Prometheus.
- Documentação da API com Swagger.

## Tecnologias Utilizadas

- **Node.js**: Plataforma para execução do JavaScript no lado do servidor.
- **Express.js**: Framework web para Node.js.
- **MongoDB**: Banco de dados NoSQL usado para armazenar as informações dos webhooks.
- **Redis**: Armazenamento opcional para configurações de monitoramento e execução de webhooks.
- **RabbitMQ**: Fila de mensagens usada para processar webhooks de forma assíncrona.
- **JWT**: Autenticação segura para a API.
- **Docker**: Containerização da aplicação para fácil deploy.
- **Docker Compose**: Orquestração dos containers da aplicação, banco de dados e fila de mensagens.
- **Winston**: Ferramenta de logging.
- **Prometheus**: Ferramenta de monitoramento.

## Requisitos

- **Node.js** (v16 ou superior)
- **Docker** e **Docker Compose**
- **MongoDB** ou **Redis** (localmente ou usando Docker)
- **RabbitMQ** (localmente ou usando Docker)

## Configuração Local

### Clonando o Repositório

```bash
git clone https://github.com/wkarts/webhookmultidb.git
cd webhookmultidb

npm install

JWT_SECRET=mysecret
STORAGE_TYPE=mongodb  # ou 'redis' para usar Redis como armazenamento
MONGODB_URI=mongodb://root:example@mongodb:27017
AMQP_URL=amqp://guest:guest@rabbitmq:5672
REDIS_URL=redis://:example@redis:6379

node app.js

docker-compose up --build

docker build -t webhookmultidb .
docker run -p 3000:3000 webhookmultidb

docker-compose up --build

http://localhost:3000/metrics

STORAGE_TYPE=mongodb  # ou 'redis'

### Explicações das Alterações:

1. **Suporte a Redis ou MongoDB**:
   - Adicionei informações sobre a variável `STORAGE_TYPE`, que permite escolher entre Redis ou MongoDB para o armazenamento das configurações de monitoramento e execução de webhooks.

2. **Monitoramento de Mudanças em Bancos de Dados**:
   - Incluí detalhes sobre o monitoramento de bancos de dados, como PostgreSQL (com `LISTEN/NOTIFY`) e MySQL (usando polling), que foi implementado na aplicação.

3. **Configuração do Docker Compose**:
   - A documentação foi atualizada para refletir a capacidade de executar a aplicação com Docker Compose, incluindo Redis, RabbitMQ e MongoDB.

4. **CI/CD com GitHub Actions**:
   - Informações sobre o fluxo de CI/CD com GitHub Actions foram mantidas e explicadas.

5. **Prometheus**:
   - Adicionei a seção de monitoramento com Prometheus para expor as métricas da aplicação.

Este `README.md` agora cobre todos os novos recursos e tecnologias utilizadas no projeto **Webhook MultiDB**, oferecendo uma visão abrangente da configuração, uso e contribuição para o projeto. Se precisar de mais ajustes, estou à disposição!