{"id":21594234,"url":"https://github.com/patricks-js/picpay-simplified","last_synced_at":"2026-04-11T02:09:11.209Z","repository":{"id":263479044,"uuid":"890535653","full_name":"patricks-js/picpay-simplified","owner":"patricks-js","description":"My solution to a simplified payment api","archived":false,"fork":false,"pushed_at":"2024-12-20T03:48:27.000Z","size":436,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T17:15:05.292Z","etag":null,"topics":["api-rest","docker","drizzle-orm","fastify","nodejs","openapi","postgresql","typescript","vitest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patricks-js.png","metadata":{"files":{"readme":"README-PT.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-18T18:31:35.000Z","updated_at":"2024-12-20T03:48:31.000Z","dependencies_parsed_at":"2024-11-19T05:35:10.314Z","dependency_job_id":null,"html_url":"https://github.com/patricks-js/picpay-simplified","commit_stats":null,"previous_names":["patricks-js/picpay-simplified"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patricks-js%2Fpicpay-simplified","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patricks-js%2Fpicpay-simplified/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patricks-js%2Fpicpay-simplified/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patricks-js%2Fpicpay-simplified/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patricks-js","download_url":"https://codeload.github.com/patricks-js/picpay-simplified/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244206954,"owners_count":20416091,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","docker","drizzle-orm","fastify","nodejs","openapi","postgresql","typescript","vitest"],"created_at":"2024-11-24T17:17:32.699Z","updated_at":"2026-04-11T02:09:11.129Z","avatar_url":"https://github.com/patricks-js.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PicPay Simplificado - Desafio Back-End\n\n[🇺🇸 English version](README.md)\n\nO objetivo deste [desafio](https://github.com/PicPay/picpay-desafio-backend) é implementar uma versão simplificada do serviço do PicPay. Deve ser possível **realizar transferências entre usuários**. Este projeto segue os princípios **RESTful**, incorporando práticas de **código limpo**, **observabilidade** e **SOLID**.\n\n## 📌 Conteúdos\n\n- [Visão Geral do Projeto](#-visão-geral-do-projeto)\n  - [Tecnologias Utilizadas](#️-tecnologias-utilizadas)\n  - [Regras de Negócio](#-regras-de-negócio)\n  - [Requisitos](#-requisitos)\n- [Diagrama ER](#-diagrama-er-entidade-relacionamento)\n- [Funcionalidades](#-funcionalidades)\n- [Instruções de Configuração](#️-instruções-de-configuração)\n  - [Pré-requisitos](#-pré-requisitos)\n  - [Instalação](#-instalação)\n  - [Uso](#-uso)\n  - [Executando Testes](#-executando-testes)\n- [Melhorias Propostas](#-melhorias-propostas)\n\n## 📝 Visão Geral do Projeto\n\nPicPay Simplificado é um serviço de pagamento que permite aos usuários **transferir** e **depositar dinheiro**. Ele suporta dois tipos de usuários:\n\n- **Cliente:** Pode enviar e receber dinheiro.\n- **Lojista:** Pode apenas receber dinheiro.\n\nCada usuário possui uma carteira para realizar transações. O sistema garante **segurança**, **validação** e **confiabilidade** durante todas as operações financeiras.\n\n### 🛠️ Tecnologias Utilizadas\n\n- **Linguagem de Programação:** TypeScript\n- **Framework:** Fastify\n- **Banco de Dados:** PostgreSQL\n- **Cache:** Redis (Proposto)\n- **Conteinerização:** Docker \u0026 Docker Compose\n- **Documentação:** Swagger/OpenAPI\n- **CI/CD:** GitHub Actions\n- **Messaging:** RabbitMQ (Proposto)\n- **Observabilidade:** Prometheus, Grafana (Proposto)\n- **Testes:** Vitest, supertest e Bruno para testes de API\n\n### 📋 Regras de Negócio\n\n- Email e CPF/CNPJ devem ser únicos\n- Clientes podem receber e realizar transferências\n- Lojistas podem apenas receber transferências\n- O saldo deve ser suficiente antes de realizar transferências\n- Toda operação de transferência é envolvida em uma transação no banco de dados para garantir atomicidade. Em caso de erro, o sistema reverte todas as operações para manter a consistência.\n- Transferências devem ser autorizadas por um [serviço externo de autorização](https://util.devi.tools/api/v2/authorize) (GET)\n- Os usuários devem receber uma notificação quando uma transferência for concluída, utilizando um [serviço externo de notificações](https://util.devi.tools/api/v1/notify) (POST)\n\n### ✅ Requisitos\n\n- [x] Usuário pode criar uma conta como cliente ou lojista\n- [x] Usuário pode autenticar-se com email e senha\n- [x] Histórico de transações disponível para todos os usuários\n- [x] Clientes podem transferir dinheiro para outros usuários (clientes ou lojistas)\n- [x] Transferências são restritas a clientes com saldo suficiente\n- [x] Todas as transferências devem ser autorizadas por um serviço externo\n- [x] Lojistas estão limitados a apenas receber transferências\n- [ ] Usuários devem receber notificações (por exemplo, email ou SMS) ao receber uma transferência\n- [x] Transferências devem ser reversíveis em caso de falha\n\n## 📊 Diagrama ER (Entidade-Relacionamento)\n\nO diagrama abaixo representa a estrutura do banco de dados usando neste projeto:\n\n![ER Diagram](.github/assets/er-diagram.png)\n\n## ✨ Funcionalidades\n\n- [ ] **Transferências seguras** entre usuários.\n- [x] Validação do **saldo da carteira** antes de transações.\n- [x] Integração com serviço externo de **autorização** para validação de transferências.\n- [ ] **Notificações** para beneficiários usando um serviço externo simulado.\n- [x] Mecanismo de **rollback** para transações com falha.\n- [ ] **Código limpo** seguindo os princípios **SOLID**.\n- [ ] **Observabilidade** com logs e monitoramento.\n- [ ] Arquitetura **escalável** e **desacoplada**.\n- [ ] API **RESTful** com documentação no Swagger.\n- [ ] Suporte para bancos de dados **relacionais** e **não relacionais**.\n- [ ] Ambiente **dockerizado** para implantação consistente.\n- [ ] Pipelines automatizados de **CI/CD**.\n\n## ⚙️ Instruções de Configuração\n\n### 📌 Pré-requisitos\n\n- Docker \u0026 Docker Compose\n- Node v20+ com `pnpm` como gerenciador de pacotes\n\n### 🚀 Instalação\n\n1. **Clone o repositório:**\n\n    ```bash\n    git clone https://github.com/patricks-js/picpay-simplified.git\n    cd picpay-simplified\n    ```\n\n2. **Instale as dependências:**\n\n    ```bash\n    pnpm install\n    ```\n\n3. **Inicie os serviços:**\n\n    ```bash\n    pnpm services:up\n    ```\n\n4. **Execute as migrações do banco de dados:**\n\n    ```bash\n    pnpm db:migrate\n    ```\n\n5. **Popule o banco de dados com alguns dados:**\n\n    ```bash\n    pnpm db:seed\n    ```\n\n### 💻 Uso\n\n1. Inicie a aplicação executando:\n\n    ```bash\n    pnpm dev\n    ```\n\n2. A API estará acessível em \u003chttp://localhost:3333\u003e\n3. A documentação da API (swagger) estará acessível em \u003chttp://localhost:3333/api/docs\u003e\n\n### 🧪 Executando Testes\n\nExecute o seguinte comando:\n\n```bash\npnpm test\n```\n\nPara ver a cobertura de código:\n\n```bash\npnpm test:coverage\n```\n\n## 🌟 Melhorias Propostas\n\n- **Tratamento de Erros:** Melhorar mensagens de erro e utilizar códigos de status semânticos.\n- **Monitoramento:** Adicionar métricas detalhadas de transações para observabilidade.\n- **Limitação de Taxa:** Implementar limitação de taxa na API e controle de solicitações para maior segurança.\n- **Otimização do Banco de Dados:** Melhorar o desempenho de consultas com índices e particionamento.\n- **Cache:** Introduzir estratégias de cache para transações de alto volume.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatricks-js%2Fpicpay-simplified","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatricks-js%2Fpicpay-simplified","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatricks-js%2Fpicpay-simplified/lists"}