{"id":28580948,"url":"https://github.com/octavioduarte/brain","last_synced_at":"2025-10-04T18:11:26.189Z","repository":{"id":209211511,"uuid":"723475663","full_name":"octavioduarte/Brain","owner":"octavioduarte","description":"A simple API using Node, Express, Typescript, Prisma, Joi and PostgreSQL.","archived":false,"fork":false,"pushed_at":"2023-11-30T01:28:27.000Z","size":106,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-11-30T02:32:07.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/octavioduarte.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}},"created_at":"2023-11-25T19:37:10.000Z","updated_at":"2023-11-25T20:18:14.000Z","dependencies_parsed_at":"2023-11-30T02:31:13.868Z","dependency_job_id":null,"html_url":"https://github.com/octavioduarte/Brain","commit_stats":null,"previous_names":["octavioduarte/brain"],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octavioduarte%2FBrain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octavioduarte%2FBrain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octavioduarte%2FBrain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octavioduarte%2FBrain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octavioduarte","download_url":"https://codeload.github.com/octavioduarte/Brain/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octavioduarte%2FBrain/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259198000,"owners_count":22820153,"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":[],"created_at":"2025-06-11T04:15:04.089Z","updated_at":"2025-10-04T18:11:21.126Z","avatar_url":"https://github.com/octavioduarte.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Executando o projeto: \n\n1º Primeiramente instale as dependêncis com: \n\n~~~bash\n npm i\n~~~\n\n2º Crie o o arquivo .env, com a variável `DATABASE_URL` com a string de conexão.\n\n\n3º Caso não tenha o [Nodemon](https://nodemon.io/) instalado, execute o comando (se já tiver o pacote instalado, pule para o passo 4) : \n\n~~~bash\n  npm install -g nodemon\n\n  #Esta função instala um pacote a nível global em sua máquina então precisa ser executada\n#com o acesso de um administrador, usando sudo no linux ou executando o terminal como administrador no Windows\n~~~\n\n4º Faça o build do projeto com o comando:\n\n~~~bash\n  npm run build\n~~~\n\n5º Para que o ORM ([prisma](https://www.prisma.io/)) faça a conexão inicial com o banco é necessário executar: \n\n~~~bash\n  npx prisma generate\n~~~\n\n6º Por último para startar o projeto na porta 3000, execute o comando\n\n~~~bash\n  npm run dev\n~~~\n\n\nSe tudo der certo você vai receber uma mensagem do [Nodemon](https://nodemon.io/) informando que o servidor está sendo executado, após isso você pode testar os endpoints.\n\n\n\n\nAbaixo estão alguns curls que você pode executar, ou se preferir copiar e colar o conteúdo do arquivo `Insomnia_2023-11-28.json` no [Insomnia](https://insomnia.rest/download).\n\n# Para cadastrar um novo produtor\n~~~curl\ncurl --request POST \\\n  --url http://localhost:3000/brain/producer \\\n  --header 'Content-Type: application/json' \\\n  --header 'User-Agent: insomnia/8.4.5' \\\n  --data '{\n\t\"name\": \"Usuário 2\",\n\t\"document\": \"09292678000\",\n\t\"document_type\": \"CPF\",\n\t\"farm\": [\n\t\t\t{\n\t\t\t\"name\": \"Fazenda Paraiba\",\n\t\t\t\"zip_code\": \"64027660\",\n\t\t\t\"area\": 2500,\n\t\t\t\"arable_area\": 1000,\n\t\t\t\"vegetation_area\": 500,\n\t\t\t\"cultures\": [\n\t\t\t\t{\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"occupation_area\": 500\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}'\n~~~\n\n\n# Para ativar ou inativar um produtor (exclusão lógica)\n\n~~~curl\ncurl --request PATCH \\\n  --url http://localhost:3000/brain/producer \\\n  --header 'Content-Type: application/json' \\\n  --header 'User-Agent: insomnia/8.4.5' \\\n  --data '{\n\t\"document\": \"09292678000\",\n\t\"document_type\": \"CPF\",\n\t\"new_status\": false\n}'\n~~~\n\n\n# Para carregar as métricas\n\n~~~curl \ncurl --request GET \\\n  --url http://localhost:3000/brain/metrics \\\n  --header 'User-Agent: insomnia/8.4.5'\n~~~\n\n\n\u003chr/\u003e\n\nRotas da aplicação: \n\nMétodo: `POST` \u003cbr/\u003e\nDescrição: *Regitrar novos produtores rurais com suas fazendas.*\n\nCenários de validação: \n\n- Verifica se o CPF ou CNPJ é válido (campo 'document').\n- Verifica se o CPF ou CNPJ já está cadastrado na base.\n- Verifica se o tipo de documento é válido (campo 'document_type') - Aceita CPF e CNPJ.\n- Valida cada campo da request para garantir que as tipagens e os atributos estão corretos.\n- Faz integração com a API da viacep para obter cidade e estado a partir do CEP.\n- Cálculo das áreas da fazenda x cultura: \n\t- Garante que a soma da área das culturas plantadas não supere a área da fazenda.\n\t- Garante que a soma da área das culturas plantadas não supere a área agricultável.\n\t- Garante que a soma da área agricutável com a área de vegetação não supera a área da fazenda.\n\u003chr/\u003e\n\nMétodo: `PATCH` \u003cbr/\u003e\nDescrição: *Altera o status de ativo do usuário.*\n\n\nCenários de validação: \n\n- Verifica se o CPF ou CNPJ é válido (campo 'document').\n- Verifica se o CPF ou CNPJ existe na base.\n- Verifica se o tipo de documento é válido (campo 'document_type') - Aceita CPF e CNPJ.\n- Valida cada campo da request para garantir que as tipagens e os atributos estão corretos.\n\t\n\t\n\u003ch4\u003eObs: Uma vez que o status esteja inativado o usuário passa a não ser considerado nos demais fluxos da API.\u003c/h4\u003e\n\n\u003chr/\u003e\n\nMétodo: `GET` \u003cbr/\u003e\nDescrição: *Carrega métricas dos dados cadastrados.*\n\n~~~json\n{\n\t\"farms_total\" // total de fazendas cadastradas\n\t\"farms_total_area_in_hct\" // soma da área das fazendas cadastradas\n\t\"farms_total_arable_area_in_hct\" // soma da área agricutável das fazendas cadastradas\n\t\"farms_total_vegetation_area_in_hct\" // soma da área de vegetação das fazendas cadastradas\n\t\"farms_total_by_state\": {\n\t\t\"sp\" // \u003c-- sigla UF: {\n\t\t\t\"farms_total\" // soma das fazendas vinculadas a um estado\n\t\t\t\"farms_total_area_in_hct\" // soma da área das fazendas cadastradas do estado\n\t\t}\n\t},\n\t\"total_by_culture\": {\n\t\t\"soja\": {\n\t\t\t\"total_occupation_in_hct\": // soma da área de ocupação da cultura\n\t\t}\n\t}\n}\n~~~","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctavioduarte%2Fbrain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctavioduarte%2Fbrain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctavioduarte%2Fbrain/lists"}