🚀Payment Gateway - Project Overview

Índice rápido para contribuir, rodar e entender o projeto.

1. Visão geral

  • Backend: Node.js + Express (src/)

  • Frontend: Vite + React (frontend/)

  • Database: SQLite local (database/payments.sqlite) — migrations em database/migrations/

  • Integrações: integrations/ (Stripe, PayPal, MercadoPago, on-chain ethers/solana)

  • Observabilidade: monitoring/ (health checks, prom-client, SSE)

2. Comandos essenciais

pnpm -w install        # instalar dependências do workspace
pnpm run migrate:db    # aplicar migrations
pnpm run dev           # iniciar backend (nodemon)
pnpm run frontend:dev  # iniciar frontend (Vite)
pnpm test              # rodar testes

3. Onde olhar primeiro (para tarefas comuns)

  • Adicionar provedor de pagamento: integrations/ (seguir adapter pattern)

  • Criar endpoint/API: src/routes/ + src/controllers/ + src/services/

  • Alterar modelo DB: src/models/Database.js e adicionar migration em database/migrations/

  • Monitoramento: monitoring/ e public/monitoring para dashboards

4. Rotas e Endpoints (resumo)

  • API root: /api/

  • Dashboard APIs: /api/dashboard/* and /dashboard/*

  • Payments APIs: /api/payments/*

  • Widgets: /api/widgets/* and widget script at /widgets/:id.js

  • Health: /api/health and /monitoring/health

5. Segurança e segredos

  • Nunca commite .env ou chaves. Use .env.example para documentar variáveis necessárias.

  • Scripts de rotação: security/scripts/rotate-keys.js.

6. Testes e qualidade

  • Unit: tests/unit/

  • Integration: tests/integration/

  • E2E: tests/e2e/

7. Próximos passos úteis

  • Gerar templates: provider adapter, migration SQL e teste unitário (posso criar agora).

  • Atualizar docs/api/openapi.yaml com endpoints reais.

  • Mover DB para PostgreSQL para produção (opcional) — adicionar migration e configurar DATABASE_URL.

Last updated

Was this helpful?