{"id":23863202,"url":"https://github.com/codingnagger/poke-challenge","last_synced_at":"2025-07-29T01:37:59.763Z","repository":{"id":211567991,"uuid":"435780099","full_name":"CodingNagger/poke-challenge","owner":"CodingNagger","description":null,"archived":false,"fork":false,"pushed_at":"2021-12-09T19:42:53.000Z","size":107,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-22T12:30:50.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","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/CodingNagger.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":"2021-12-07T07:14:48.000Z","updated_at":"2021-12-09T19:42:56.000Z","dependencies_parsed_at":"2023-12-09T12:37:34.078Z","dependency_job_id":null,"html_url":"https://github.com/CodingNagger/poke-challenge","commit_stats":null,"previous_names":["codingnagger/poke-challenge"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CodingNagger/poke-challenge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodingNagger%2Fpoke-challenge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodingNagger%2Fpoke-challenge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodingNagger%2Fpoke-challenge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodingNagger%2Fpoke-challenge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodingNagger","download_url":"https://codeload.github.com/CodingNagger/poke-challenge/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodingNagger%2Fpoke-challenge/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267616855,"owners_count":24116170,"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-07-28T02:00:09.689Z","response_time":68,"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-01-03T07:50:25.020Z","updated_at":"2025-07-29T01:37:59.725Z","avatar_url":"https://github.com/CodingNagger.png","language":"Java","readme":"# Pokemon challenge API\n\n## Description\n\nFun project playing around the [PokeAPI](https://pokeapi.co/) and [FunTranslations API](https://funtranslations.com/).\n\n## How to run the API?\n\n### Pre-requisites\n\nYou need Docker installed. Docker is supported on Windows, Mac OS and most Linux distributions. \nYou can find more information on [how to install it here](https://docs.docker.com/engine/install/).\n\n### Build the image\n\n```shell\ndocker image build -t poke-challenge .\n```\n## Starting a container from the image\n\n```shell\ndocker run -p 5000:5000 poke-challenge\n```\n\n## Endpoints available\n\n### Basic Pokemon Information\n\n```text\nGET /pokemon/{pokemon name}\n```\n\nExample response for request `GET /pokemon/wartortle`\n\n```text\n{\n    \"name\": \"Wartortle\",\n    \"description\": \"Often hides in\\nwater to stalk\\nunwary prey. For\\fswimming fast, it\\nmoves its ears to\\nmaintain balance.\",\n    \"habitat\": \"waters-edge\",\n    \"legendary\": false\n}\n```\n\n### Translated Pokemon Information\n\n```text\nGET /pokemon/translated/{pokemon name}\n```\n\nExample response for request `GET /pokemon/translated/wartortle`\n\n```text\n{\n    \"name\": \"Wartortle\",\n    \"description\": \"Oft hides in water to stalk unwary prey. For swimming festinate,  't moves its ears to maintain balance.\",\n    \"habitat\": \"waters-edge\",\n    \"legendary\": false\n}\n```\n\n## Potential improvements to make it production ready\n\n- Add healthcheck endpoints for integration with Kubernetes and other devops tools to validate the \ndeployment.\n- Add caching at the PokemonService level either and at the FunTranslationService level, in-memory\ncould be sufficient if only one instance is deployed. Using Redis might be more suitable if multiple\ninstances of this service must run together.\n- Add documentation through Swagger endpoints if developers are to consume this API.\n- Allow setting the language through configuration rather than constantly using english.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodingnagger%2Fpoke-challenge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodingnagger%2Fpoke-challenge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodingnagger%2Fpoke-challenge/lists"}