{"id":17972741,"url":"https://github.com/gfpaiva/wishlist-api","last_synced_at":"2026-02-08T13:05:14.892Z","repository":{"id":55923904,"uuid":"306745071","full_name":"gfpaiva/wishlist-api","owner":"gfpaiva","description":"Wishlist API É uma API pública para criar e gerenciar listas de desejos.","archived":false,"fork":false,"pushed_at":"2020-12-07T02:25:29.000Z","size":114,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-14T13:26:28.159Z","etag":null,"topics":["api-rest","docker","fastapi","postgresql","python3","redis"],"latest_commit_sha":null,"homepage":"https://gfpaiva-wishlist-api.herokuapp.com/docs","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/gfpaiva.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}},"created_at":"2020-10-23T20:54:51.000Z","updated_at":"2020-12-07T02:18:49.000Z","dependencies_parsed_at":"2022-08-15T09:31:16.822Z","dependency_job_id":null,"html_url":"https://github.com/gfpaiva/wishlist-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfpaiva%2Fwishlist-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfpaiva%2Fwishlist-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfpaiva%2Fwishlist-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gfpaiva%2Fwishlist-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gfpaiva","download_url":"https://codeload.github.com/gfpaiva/wishlist-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247887639,"owners_count":21012983,"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":["api-rest","docker","fastapi","postgresql","python3","redis"],"created_at":"2024-10-29T16:25:37.342Z","updated_at":"2026-02-08T13:05:14.865Z","avatar_url":"https://github.com/gfpaiva.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python application](https://github.com/gfpaiva/wishlist-api/workflows/Python%20application/badge.svg)](https://github.com/gfpaiva/wishlist-api/actions?query=workflow%3A%22Python+application%22)\n[![CodeFactor](https://www.codefactor.io/repository/github/gfpaiva/wishlist-api/badge)](https://www.codefactor.io/repository/github/gfpaiva/wishlist-api)\n[![codecov](https://codecov.io/gh/gfpaiva/wishlist-api/branch/main/graph/badge.svg?token=MRSD5MVV9H)](https://codecov.io/gh/gfpaiva/wishlist-api)\n[![StackShare](http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/gfpaiva/wishlist-api)\n\n# WISHLIST API\n\n[Wishlist Api](https://gfpaiva-wishlist-api.herokuapp.com/docs) É uma API Pública (com autenticação de aplicação) para criar e gerenciar listas de desejos.\n\nCriado como side project para estudo e diversão 🤓.  \nDesenvolvido a partir das especificações técnicas do desafio técnico do [LuizaLabs](http://luizalabs.com/), consumindo [API externa](https://gist.github.com/Bgouveia/9e043a3eba439489a35e70d1b5ea08ec) para detalhe dos produtos.\n\n## ⚙️ Requisitos\n\nRecomendado (principalmente para desenvolvimento local):\n\n- [Docker\\*](https://www.docker.com/)\n\nOu instalação a parte dos serviços:\n\n- [Python 3.8](https://www.python.org/)\n- [Postgres 13.0](http://postgresql.org/)\n- [Redis](https://redis.io/)\n\n\\* Dica para linux: [Post-installation](https://docs.docker.com/engine/install/linux-postinstall/) recomendado para não precisar rodar comandos docker com `sudo` 😉\n\n## 🏃🏽‍♂️ Rodando local\n\nPrimeiro de tudo você precisa criar um arquivo `.env` na raiz do projeto.  \nVocê pode usar o arquivo `.env.example`, apenas duplicá-lo e renomeá-lo para `.env` já te deixa preparado para o desenvolvimento local.\n\nScripts:\n\n| comando       | descrição                                                                                     |\n| ------------- | --------------------------------------------------------------------------------------------- |\n| make dev      | Encerra processo anterior, e cria novo através do _docker-compose_ (python, postgres e redis) |\n| make dev-logs | Exibe logs dos serviços do _docker-compose_ caso estejam rodando                              |\n\nCaso seu sistema não tenha suporte para rodar comandos do [make](https://pt.wikipedia.org/wiki/Makefile) você pode copiar e rodar manualmente as receitas que estão no arquivo `./Makefile`.  \nApós os serviços e aplicação rodando, você pode acessar [http://localhost:3000](http://localhost:3000) para desenvolvimento e teste da API. Todos os endpoints estão documentados via [SwaggerUI](https://swagger.io/tools/swagger-ui/), que pode ser acessado no endereço [http://localhost:3000/docs](http://localhost:3000/docs).\n\nUma autenticação inicial é criada para realizar os testes local:\n\n- usuário `wishlist`\n- senha `wishlist`\n\n(receitas podem ser conferidas em `db/init.sql`)\n\n## ✔️ Qualidade\n\nAlguns checks feitos no código assegurando mais qualidade:\n\n- [Github Actions](https://github.com/gfpaiva/wishlist-api/actions?query=workflow%3A%22Python+application%22) (Lint e testes)\n- [CodeCov](https://codecov.io/gh/gfpaiva/wishlist-api) (Cobertura de testes)\n- [CodeFactor](https://www.codefactor.io/repository/github/gfpaiva/wishlist-api) (CodeScanner verificando vulnerabilidades e code smells)\n\n## 🔍 Testes\n\nScripts:\n\n| comando               | descrição                                                                                          |\n| --------------------- | -------------------------------------------------------------------------------------------------- |\n| make test             | Roda testes de unidade dos services da aplicação                                                   |\n| make test-cov         | Roda testes de unidade dos services da aplicação e gera relatórios de coverage                     |\n| make test-integration | Inicia serviços através do _docker-compose_ e roda testes de integração dos endpoints da aplicação |\n\n## 🚀 Deploy\n\nHospedado no [Heroku](https://www.heroku.com/). E pode ser acessado no endereço [https://gfpaiva-wishlist-api.herokuapp.com/docs](https://gfpaiva-wishlist-api.herokuapp.com/docs) (Documentação)  \nProcesso de deploy e build são feitos automaticamente após sucesso dos checks do Github Actions na branch `main`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgfpaiva%2Fwishlist-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgfpaiva%2Fwishlist-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgfpaiva%2Fwishlist-api/lists"}