{"id":21070875,"url":"https://github.com/gitkodev/pokemon-api","last_synced_at":"2025-05-16T05:31:15.874Z","repository":{"id":222091222,"uuid":"756210079","full_name":"gitkoDev/pokemon-api","owner":"gitkoDev","description":":unicorn::lion::monkey_face: Pokedex REST API created with GO and PostgreSQL","archived":false,"fork":false,"pushed_at":"2024-03-29T05:40:35.000Z","size":6483,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T20:43:12.449Z","etag":null,"topics":["clean-architecture","docker","go","golang","golang-api-examples","mock-testing","pokedex-api","pokemon","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Go","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/gitkoDev.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":"2024-02-12T07:44:09.000Z","updated_at":"2024-07-19T00:48:27.000Z","dependencies_parsed_at":"2024-03-29T06:25:32.886Z","dependency_job_id":"8f98b865-328c-4c95-80b5-e4e764efca97","html_url":"https://github.com/gitkoDev/pokemon-api","commit_stats":null,"previous_names":["gitkodev/pokemon-db"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitkoDev%2Fpokemon-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitkoDev%2Fpokemon-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitkoDev%2Fpokemon-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitkoDev%2Fpokemon-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitkoDev","download_url":"https://codeload.github.com/gitkoDev/pokemon-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254474041,"owners_count":22077203,"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":["clean-architecture","docker","go","golang","golang-api-examples","mock-testing","pokedex-api","pokemon","rest-api"],"created_at":"2024-11-19T18:48:43.412Z","updated_at":"2025-05-16T05:31:10.858Z","avatar_url":"https://github.com/gitkoDev.png","language":"Go","readme":"# Go Pokedex REST API\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://lirp.cdn-website.com/61e0cb41/dms3rep/multi/opt/pngimg.com+-+pokeball_PNG24-1920w.png\" width=\"200\" alt=\"Nest Logo\" /\u003e\n\u003c/p\u003e\n\nPokedex REST API allows users to keep track of caught pokemon and their stats: `TYPE`, `HP`, `ATTACK`, and `DEFENSE`. The API utilizes JWT authentification for additional security as well as a number of other tools (look below). The projects structure implements `clean architecture` and `dependecy injection` principles \n\n## Endpoints\n\n#### API\n- **/v1/pokemon \u0026ensp;** `=\u003e`  \u0026ensp; **POST** \u0026ensp;  `=\u003e` \u0026ensp; Add pokemon\n- **/v1/pokemon \u0026ensp;** `=\u003e`  \u0026ensp; **GET** \u0026ensp;  `=\u003e` \u0026ensp; Get all pokemon\n- **/v1/pokemon/{id} \u0026ensp;** `=\u003e`  \u0026ensp; **GET** \u0026ensp;  `=\u003e` \u0026ensp; Get pokemon by id\n- **/v1/pokemon/{id} \u0026ensp;** `=\u003e`  \u0026ensp; **PUT** \u0026ensp;  `=\u003e` \u0026ensp; Update pokemon by id\n- **/v1/pokemon/{id} \u0026ensp;** `=\u003e`  \u0026ensp; **DELETE** \u0026ensp;  `=\u003e` \u0026ensp; Delete pokemon by id\n  \n#### Other\n- **/health \u0026ensp;**  `=\u003e` \u0026ensp; **GET** \u0026ensp; `=\u003e` \u0026ensp; Ping the database connection\n- **/auth/sign-up \u0026ensp;**  `=\u003e` \u0026ensp; **POST** \u0026ensp; `=\u003e` \u0026ensp; Create new pokemon trainer\n- **/auth/sign-in \u0026ensp;** `=\u003e`  \u0026ensp; **POST** \u0026ensp;  `=\u003e` \u0026ensp; Sign in with existing profile to generate JWT authentification token\n\n## Tools used\n\n- `App configuration` \u0026nbsp; **=\u003e**  \u0026nbsp; [Viper](https://github.com/spf13/viper)\n- `Logging` \u0026nbsp; **=\u003e**  \u0026nbsp; [Logrus](https://github.com/sirupsen/logrus)\n- `Routing` \u0026nbsp; **=\u003e**  \u0026nbsp;  [Chi](https://github.com/go-chi/chi)\n- `Database` \u0026nbsp; **=\u003e**  \u0026nbsp;  Postgres + [pgx](https://github.com/jackc/pgx/)\n- `Database migrations` \u0026nbsp; **=\u003e**  \u0026nbsp; [Goose](https://github.com/pressly/goose#sql-migrations)\n- `Containerization` \u0026nbsp; **=\u003e**  \u0026nbsp; [Docker](http://docker.com/) + Docker Compose\n- `Authentification and middleware` \u0026nbsp; **=\u003e**  \u0026nbsp;  [JWT Go](https://github.com/golang-jwt/jwt)\n- `Testing` \u0026nbsp; **=\u003e**  \u0026nbsp; [Sqlmock](https://github.com/DATA-DOG/go-sqlmock) + [Gomock](https://github.com/uber-go/mock) + [Testify](https://github.com/stretchr/testify)\n\n## Installation\n```\nmake initUp\n```\n\n## Running the app\n\n```bash\n# rebuild containers\nmake build\n\n# start the app\nmake run\n\n# run psql utility\nmake startPsql\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitkodev%2Fpokemon-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitkodev%2Fpokemon-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitkodev%2Fpokemon-api/lists"}