{"id":24517871,"url":"https://github.com/moattarwork/pokedex","last_synced_at":"2025-03-15T11:11:27.120Z","repository":{"id":88929114,"uuid":"359069997","full_name":"moattarwork/Pokedex","owner":"moattarwork","description":null,"archived":false,"fork":false,"pushed_at":"2021-04-18T18:18:20.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T01:36:51.207Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/moattarwork.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":"2021-04-18T07:04:36.000Z","updated_at":"2021-04-18T18:18:22.000Z","dependencies_parsed_at":"2023-06-13T03:45:40.324Z","dependency_job_id":null,"html_url":"https://github.com/moattarwork/Pokedex","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/moattarwork%2FPokedex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moattarwork%2FPokedex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moattarwork%2FPokedex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moattarwork%2FPokedex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moattarwork","download_url":"https://codeload.github.com/moattarwork/Pokedex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243719398,"owners_count":20336607,"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-01-22T01:35:48.359Z","updated_at":"2025-03-15T11:11:27.112Z","avatar_url":"https://github.com/moattarwork.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pokedex\n\nPokedex is an API layer on top of PokeAPI and FunTranslateAPI which provides endpoints to retrieve Pokemon info in english and also get them in some fun translation such as Yoda or Shakespeare.\n\nThe project has been developed on .Net 5 so in order to build/run the project .net 5.0 SDK/runtime need to be installed. You can download them from https://dotnet.microsoft.com/download/dotnet/5.0 depend on your operating system and also your hardware configuration. \n\n## How to build/run\n\nIn order to run the project:\n\n```\ngit clone https://github.com/moattarwork/pokedex\n\ncd pokedex\\src\n\ndotnet build\ndotnet .\\Pokedex.WebApi\\bin\\Debug\\net5.0\\Pokedex.WebApi.dll \n```\n\nNow the application available to run:\n\n```\n# pokemon info\ncurl https://localhost:5000/pokemon/\u003cname\u003e\n\nFor example:\n    curl https://localhost:5000/pokemon/mewtwo\n\n# pokemon translated info\ncurl https://localhost:5000/pokemon/translated/\u003cname\u003e\n\nFor example:\n    curl https://localhost:5000/pokemon/translated/mewtwo\n```\n\n### Open API EndPoint\n\nThe API contains the Open API endpoint which can be used to test the endpoints in the browser. The Open API is available on http://localhost:5000/swagger \n\n### Running in the Docker\n\nAn alternative way of running the application is to run docker-compose file in the command line:\n\n```\ncd pokedex\\src\n\ndocker-compose up -d\n\n```\n**NOTE: to be able to run the application in the docker, the docker desktop must be available on your machine. You can download the docker desktop from https://www.docker.com/products/docker-desktop** \n\n## Production considerations\n- Enabling resiliency on external API calls (Retry, CircuitBreaker, etc) using libraries such as Polly\n- Generic poke info is pretty static and it worth to enable a proper caching solution on the API\n- Extended logging \u0026 enabling telemetry/monitoring\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoattarwork%2Fpokedex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoattarwork%2Fpokedex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoattarwork%2Fpokedex/lists"}