{"id":31484177,"url":"https://github.com/pedrovidaldev/chico","last_synced_at":"2025-10-02T09:41:56.596Z","repository":{"id":317203899,"uuid":"1065312407","full_name":"PedroVidalDev/chico","owner":"PedroVidalDev","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-29T13:38:19.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-29T15:19:25.424Z","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/PedroVidalDev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-27T13:22:25.000Z","updated_at":"2025-09-29T13:38:23.000Z","dependencies_parsed_at":"2025-09-29T15:30:13.852Z","dependency_job_id":null,"html_url":"https://github.com/PedroVidalDev/chico","commit_stats":null,"previous_names":["pedrovidaldev/chico"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/PedroVidalDev/chico","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PedroVidalDev%2Fchico","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PedroVidalDev%2Fchico/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PedroVidalDev%2Fchico/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PedroVidalDev%2Fchico/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PedroVidalDev","download_url":"https://codeload.github.com/PedroVidalDev/chico/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PedroVidalDev%2Fchico/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277987443,"owners_count":25910594,"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","status":"online","status_checked_at":"2025-10-02T02:00:08.890Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-10-02T09:41:53.114Z","updated_at":"2025-10-02T09:41:56.585Z","avatar_url":"https://github.com/PedroVidalDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cp align=\"center\"\u003e Chico \u003c/p\u003e\r\n\r\n## Conceito\r\n\r\nRepositório para entrega da tarefa da Fatec Ferraz de Vasconcelos, consistindo na criação de uma REST API para comunicação com um banco de dados MongoDB.\r\n\r\n- Propostas de endpoints:\r\n    - GET de cidades por estado\r\n    - GET de cidade por nome\r\n\r\n## Como rodar\r\n\r\nPara rodar o projeto basta seguir os passos abaixo:\r\n- Rodar o comando ```npm i``` para instalar as bibliotecas do projeto\r\n- Definir as envs de ambiente (exemplo no arquivo ./env.example)\r\n- Finalizar com o comando ```npm run dev```\r\n\r\n## Entidades\r\n\r\n### City\r\n```ts\r\nexport interface ICity {\r\n  name: string;\r\n  state: string;\r\n  country: string;\r\n  birthday: Date;\r\n  population: number;\r\n}\r\n```\r\n\r\n## Testes\r\n\r\nPara testar a aplicação será necessário utilizar de seus endpoints.\r\n- ```/cities``` endpoint para pegar todas as cidades cadastradas em seu DB.\r\n- ```/cities?name=example``` endpoint usado para realizar filtros de cidade por seu nome, vale mencionar que o exemplo com name pode ser trocado para qualquer chave da entidade City.\r\n\r\n## Tratamento de Erro\r\n\r\nO sistema conta com um tratamento de erro para o caso de não achar registros ou erros de conexão com o banco de dados.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedrovidaldev%2Fchico","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedrovidaldev%2Fchico","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedrovidaldev%2Fchico/lists"}