{"id":17008925,"url":"https://github.com/barbaracalderon/pokedex-api","last_synced_at":"2026-04-07T08:01:34.800Z","repository":{"id":243312630,"uuid":"811103203","full_name":"barbaracalderon/pokedex-api","owner":"barbaracalderon","description":"The Pokédex project is a comprehensive system developed to manage and provide detailed information about Pokémon. It consists of a backend API built with FastAPI and a frontend interface developed using Angular. Docker is used for deploy and Pytest for unit tests.","archived":false,"fork":false,"pushed_at":"2025-01-18T19:13:07.000Z","size":1606,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-25T02:44:00.299Z","etag":null,"topics":["angular","backend","css3","docker","docker-compose","docker-composer","fastapi","frontend","ngx-bootstrap","pokemon-api","pytest","python","typescript"],"latest_commit_sha":null,"homepage":"","language":"Python","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/barbaracalderon.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-06T00:02:37.000Z","updated_at":"2024-07-09T15:54:48.000Z","dependencies_parsed_at":"2024-06-08T00:37:16.734Z","dependency_job_id":"ca0755a6-5c2a-4e8d-9dca-5ff93eca2f34","html_url":"https://github.com/barbaracalderon/pokedex-api","commit_stats":null,"previous_names":["barbaracalderon/pokedex-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/barbaracalderon/pokedex-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barbaracalderon%2Fpokedex-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barbaracalderon%2Fpokedex-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barbaracalderon%2Fpokedex-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barbaracalderon%2Fpokedex-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barbaracalderon","download_url":"https://codeload.github.com/barbaracalderon/pokedex-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barbaracalderon%2Fpokedex-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31504897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["angular","backend","css3","docker","docker-compose","docker-composer","fastapi","frontend","ngx-bootstrap","pokemon-api","pytest","python","typescript"],"created_at":"2024-10-14T05:42:16.549Z","updated_at":"2026-04-07T08:01:34.782Z","avatar_url":"https://github.com/barbaracalderon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"_(Versão em Português-BR | [Click here for English version](https://github.com/barbaracalderon/pokedex-api/blob/main/README.md))_\n\n# Pokédex API e Frontend\n\nEste projeto consiste em construir uma API Pokédex e uma interface frontend simples para interagir com ela. A API Pokédex foi desenvolvida usando FastAPI em Python, e o frontend foi construído usando Angular.\n\nOs principais objetivos do projeto Pokédex são os seguintes:\n- Criar uma API para gerenciar uma lista de Pokémon capturados com paginação e visualizações detalhadas.\n- Desenvolver uma interface frontend amigável para navegar e acessar informações sobre os Pokémon.\n- Implementar recursos adicionais, como exportação de dados de Pokémon e geração de documentação.\n- Uso de **Gitflow** para o desenvolvimento.\n- Testes unitários com Pytest.\n- Docker e Docker-Compose para build e deploy.\n\n\n## Autora\nBarbara Calderon, desenvolvedora de software.\n\n- [Github](https://www.github.com/barbaracalderon)\n- [LinkedIn](https://www.linkedin.com/in/barbaracalderondev)\n- [Twitter](https://www.x.com/bederoni)\n\n## Índice\n- [Visão Geral](#visão-geral)\n- [Requisitos da API](#requisitos-da-api)\n- [Executar Localmente](#executar-localmente)\n\n## Visão Geral\nO principal objetivo deste projeto é criar uma API Pokédex que gerencie uma lista de Pokémon capturados com paginação e uma interface frontend simples para visualizar a lista de Pokémon e seus detalhes.\n\nAbaixo, algumas imagens.\n\n![Projeto Pokédex](frontend/images/home.png)\n![Projeto Pokédex](frontend/images/pokemon.png)\n![Projeto Pokédex](frontend/images/data.png)\n![Projeto Pokédex](frontend/images/data2.png)\n![Projeto Pokédex](frontend/images/export.png)\n![Projeto Pokédex](frontend/images/export2.png)\n![Projeto Pokédex](frontend/images/swagger.png)\n\n## Requisitos\n\n### API\n1. **URL Base**: Recuperar dados de `https://pokeapi.co/api/v2/pokemon`.\n2. **Paginação**: Implementar paginação com o comportamento padrão listando todos os Pokémon se nenhum offset ou limite for especificado.\n3. **Visualização Detalhada**: Implementar uma página detalhada para cada Pokémon semelhante a `https://www.pokemon.com/us/pokedex`.\n4. **Busca de Dados**:\n   - Usar `httpx` para busca de dados.\n   - Garantir que os dados buscados sejam suficientes para replicar os detalhes encontrados em `https://www.pokemon.com/us/pokedex`.\n5. **Ordenação**: Ordenar os resultados da API alfabeticamente pelo nome do Pokémon.\n6. **Funcionalidade de Exportação**: Capacidade de exportar a lista ordenada de Pokémon para um arquivo XML.\n7. **Documentação**:\n   - Fornecer documentação da API usando Swagger.\n   - Seguir as melhores práticas no desenvolvimento da API.\n\n### Requisitos do Frontend\n1. **Tecnologias**: Usar Angular.\n2. **Funcionalidades**: A interface deve permitir visualizar a lista de Pokémon e os detalhes de cada Pokémon individual.\n\n## Executar Localmente\n\nClone este repositório: `git clone git@github.com:barbaracalderon/pokedex-api.git`\n\n### Usando Docker e Docker Compose\n\nPara executar a aplicação usando Docker e Docker Compose, siga estas etapas:\n\n1. Certifique-se de que o Docker e o Docker Compose estão instalados em seu sistema.\n2. Navegue até o diretório do projeto: `cd pokedex-api`\n3. Execute a aplicação: `docker-compose up`\n\nIsso irá construir e iniciar os serviços de backend e frontend.\n\n#### Acessando os Serviços\n\n- **Frontend**: O frontend Angular estará acessível em `http://localhost:4200`. Você pode abrir seu navegador e navegar para este URL para usar a interface frontend.\n\n- **API Backend**: O backend FastAPI estará acessível em `http://localhost:8000`. Você pode acessar a documentação da API (Swagger UI) em `http://localhost:8000/docs`.\n\n### Endpoints da API\n| Método | Endpoint          | Descrição                                    |\n|--------|-------------------|----------------------------------------------|\n| GET    | /pokemons         | Lista Pokémon                                |\n| GET    | /data             | Lista dados de Pokémon                       |\n| GET    | /docs             | Documentação Swagger do OpenAPI              |\n| GET    | /export           | Exporta a lista de Pokémon em formato XML    |\n\n## Outros\n\n### Frontend\n\nEste projeto foi gerado com [Angular CLI](https://github.com/angular/angular-cli) versão 17.3.7.\n\n### Servidor de Desenvolvimento\n\nExecute `ng serve` para um servidor de desenvolvimento. Navegue até `http://localhost:4200/`. A aplicação será recarregada automaticamente se você alterar qualquer um dos arquivos de origem.\n\n### Criação de Código\n\nExecute `ng generate component nome-componente` para gerar um novo componente. Você também pode usar `ng generate directive|pipe|service|class|guard|interface|enum|module`.\n\n### Construir\n\nExecute `ng build` para construir o projeto. Os artefatos de construção serão armazenados no diretório `dist/`.\n\n### Executando Testes Unitários\n\nExecute `ng test` para executar os testes unitários via [Karma](https://karma-runner.github.io).\n\n### Executando Testes de Extremidade a Extremidade\n\nExecute `ng e2e` para executar os testes de extremidade a extremidade via uma plataforma de sua escolha. Para usar este comando, você precisa primeiro adicionar um pacote que implemente capacidades de teste de extremidade a extremidade.\n\n### Mais Ajuda\n\nPara obter mais ajuda sobre o Angular CLI, use `ng help` ou consulte a [Visão Geral e Referência de Comandos do Angular CLI](https://angular.io/cli).\n\n## Considerações Finais\nO projeto Pokédex representa a culminação de esforços para criar um sistema de gerenciamento de Pokémon abrangente e amigável. Desenvolvido por mim, Barbara Calderon, o projeto visa simplificar o processo de gerenciamento e acesso a dados de Pokémon, proporcionando uma experiência de usuário perfeita.\n\nEsperamos que este sistema atenda às suas necessidades e melhore suas atividades relacionadas a Pokémon.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarbaracalderon%2Fpokedex-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarbaracalderon%2Fpokedex-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarbaracalderon%2Fpokedex-api/lists"}