{"id":19036380,"url":"https://github.com/thenriquedb/begou-api","last_synced_at":"2026-04-11T10:32:29.247Z","repository":{"id":63694600,"uuid":"532025942","full_name":"thenriquedb/begou-api","owner":"thenriquedb","description":"Aplicativo que tem como objetivo auxiliar a equipe dos abrigos e Organização Não Governamental (ONGs) a divulgar e arrecadar verba para animais que se encontram em condição de fragilidade. ","archived":false,"fork":false,"pushed_at":"2023-03-07T01:50:22.000Z","size":1476,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-02T05:41:45.995Z","etag":null,"topics":["api-rest","cd","ci","clean-architecture","docker","express","jest","mysql","nodejs","rest","solid","sqlite","typeorm","typescript"],"latest_commit_sha":null,"homepage":"https://api.begou.xyz/api-docs/","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/thenriquedb.png","metadata":{"files":{"readme":"README.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":"2022-09-02T17:48:21.000Z","updated_at":"2023-03-08T23:22:30.000Z","dependencies_parsed_at":"2025-01-02T16:01:30.142Z","dependency_job_id":null,"html_url":"https://github.com/thenriquedb/begou-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fbegou-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fbegou-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fbegou-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fbegou-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thenriquedb","download_url":"https://codeload.github.com/thenriquedb/begou-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240093145,"owners_count":19746776,"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","cd","ci","clean-architecture","docker","express","jest","mysql","nodejs","rest","solid","sqlite","typeorm","typescript"],"created_at":"2024-11-08T21:54:17.766Z","updated_at":"2025-12-30T19:41:29.032Z","avatar_url":"https://github.com/thenriquedb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Begou\n\n\u003cp align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"docs/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge\u0026logo=express\u0026logoColor=%2361DAFB\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge\u0026logo=docker\u0026logoColor=white\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/DigitalOcean-%230167ff.svg?style=for-the-badge\u0026logo=digitalOcean\u0026logoColor=white\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/mysql-%2300f.svg?style=for-the-badge\u0026logo=mysql\u0026logoColor=white\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge\u0026logo=jest\u0026logoColor=whit\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge\u0026logo=eslint\u0026logoColor=white\"/\u003e\n\u003c/p\u003e\n\n## Índice\n- [Begou](#begou)\n  - [Índice](#índice)\n  - [1. Introdução](#1-introdução)\n  - [2. Motivação](#2-motivação)\n  - [3. Objetivos](#3-objetivos)\n  - [4. Projeto](#4-projeto)\n    - [4.1 Arquitetura](#41-arquitetura)\n    - [4.2 Configurando o projeto](#42-configurando-o-projeto)\n    - [4.3 Comandos](#43-comandos)\n    - [4.4 Usuários pré-cadastrados](#44-usuários-pré-cadastrados)\n  - [5. Documentação](#5-documentação)\n\n\n## 1. Introdução\nAplicativo que tem como objetivo auxiliar a equipe dos abrigos e Organização Não Governamental (ONGs) a divulgar e arrecadar verba para animais que se encontram em condição de fragilidade.\n\n\n## 2. Motivação\nDe acordo com a pesquisa realizada pelo Instituto Pet em 2019, apontou que o Brasil possui cerca de 3,9 milhões de animais que se encontram na Condição de Vulnerabilidade. \n\nCom isso  \n\n## 3. Objetivos\n- Auxiliar ONGs no processo de localização e captura de animais;\n- Arrecadação de verbas para as ONGs cadastradas; \n- Facilitar o processo de quem quer ajudar em relação ao abandono dos animais;\n- Incentivar a adoção dos animais resgatados;\n- Facilitar o processo de quem quer ajudar em relação ao abandono dos animais;\n\n## 4. Projeto\n### 4.1 Arquitetura\nO projeto foi criado utilizando a arquitetura limpa. Este padrão foi proposto pelo  Robert C. Martin (Uncle Bob) em seu blog pessoal no ano de 2012. Essa arquitetura tem como objetivo produzir sistemas que são:\n\n- Independência de frameworks;\n- Testabilidade;\n- Independência de UI;\n- Independência de banco de dados;\n- Independência de fatores externos;\n\n### 4.2 Configurando o projeto\n**Depedências globais**\n- Node v16 (ou superior);\n- Docker engine com Docker compose;\n\n### 4.3 Comandos\n\n**`yarn bootstrap`**: configura o schema do banco de dados e o popula com os dados pré definido;\n\n**`yarn dev`**: roda a aplicações no modo desenvolvimento;\n\n**`yarn build`**: gera uma build de produção;\n\n**`yarn start`**: roda a build de produção;\n\n**`yarn migration:create \u003cmigration-name\u003e`**: Cria uma nova migration;\n\n**`yarn migration:revert`**: Reverte as alterações realizadas pelas migration;\n\n**`yarn migration:run`**: Executa todas as migrations pendentes;`\n\n**`yarn seed`**: Popula o banco de dados com algumas informações padrões.\n\n### 4.4 Usuários pré-cadastrados \nAo rodar o comando `yarn bootstrap` será criado criado dois usuários, no qual um possui *role* de fundador e pode realizar  operações de cadastrar e editar animais de uma instituição.Segue abaixo as credenciais destes dois usuários:\n\n**Usuário fundador**:\n```\nEmail: founder@email.com \nSenha: 123456\n``` \n\n**Usuário comum**:\n```\nEmail: user@email.com \nSenha: 123456 \n``` \n\n## 5. Documentação\n\nDocumentação criada utilizando o padrão [**OpenAPI 3.0**](https://swagger.io/specification/) juntamente com a biblioteca [**Swagger**](https://swagger.io/). \n\n\u003ch3\u003e\n  \u003ca href=\"https://api.begou.xyz/api-docs/\"\u003e\n   \u003cb\u003e\n    Link para a documentação da API\n   \u003c/b\u003e\n  \u003c/a\u003e\n\u003c/h3\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenriquedb%2Fbegou-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthenriquedb%2Fbegou-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenriquedb%2Fbegou-api/lists"}