{"id":30842739,"url":"https://github.com/geisonjr/spotify-api","last_synced_at":"2025-10-12T03:36:22.311Z","repository":{"id":309251690,"uuid":"1033537961","full_name":"GeisonJr/spotify-api","owner":"GeisonJr","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-10T20:14:35.000Z","size":230,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T05:50:40.987Z","etag":null,"topics":["portfolio"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/GeisonJr.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,"zenodo":null}},"created_at":"2025-08-07T01:22:17.000Z","updated_at":"2025-08-21T11:50:12.000Z","dependencies_parsed_at":"2025-08-10T21:18:44.366Z","dependency_job_id":"7b7586dc-25a3-4e3e-ad0e-7a7d9c299577","html_url":"https://github.com/GeisonJr/spotify-api","commit_stats":null,"previous_names":["geisonjr/spotify-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GeisonJr/spotify-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeisonJr%2Fspotify-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeisonJr%2Fspotify-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeisonJr%2Fspotify-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeisonJr%2Fspotify-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeisonJr","download_url":"https://codeload.github.com/GeisonJr/spotify-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeisonJr%2Fspotify-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273962601,"owners_count":25198601,"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-09-06T02:00:13.247Z","response_time":2576,"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":["portfolio"],"created_at":"2025-09-06T21:07:21.168Z","updated_at":"2025-10-12T03:36:17.273Z","avatar_url":"https://github.com/GeisonJr.png","language":"TypeScript","readme":"# Spotify API - Backend\n\n\u003e ⚠ Este repositório contém o backend da aplicação.\n\nA aplicação implementa autenticação e consumo da API do Spotify via OAuth 2.0, expondo endpoints para serem consumidos pelo frontend React.\n\n## Versão para Apresentação\n\nA versão de apresentação está disponível online para testes em: [https://spotify.geison.dev](https://spotify.geison.dev)\n\nPara acessar, é necessário autenticar com uma conta do Spotify. Por favor, envie seu nome e e-mail da conta Spotify para que eu possa adicioná-lo(a) como usuário autorizado.\n\n## Links Úteis\n\nDocumentação interativa da API (via Scalar): \u003chttps://docs.spotify.geison.dev\u003e\n\n\u003e ⚠ O [Scalar](https://scalar.com) é um visualizador moderno para arquivos OpenAPI, usado aqui para explorar e testar os endpoints gerados pelo backend.\n\nRepositório do backend: \u003chttps://github.com/GeisonJr/spotify-api\u003e\n\nRepositório do frontend: \u003chttps://github.com/GeisonJr/spotify-app\u003e\n\n## 🚀 Tecnologias utilizadas\n\n* **Node.js** + **TypeScript** – execução e tipagem\n* **Express.js** – framework HTTP\n* **Jest** – testes unitários\n* **ESLint** – padronização de código\n* **Docker** – containerização\n* **Fly.io** – deploy\n* **dotenv** – configuração de variáveis de ambiente\n\n## 📌 Funcionalidades implementadas\n\n* Autenticação com Spotify [OAuth 2.0 Authorization Code Flow com refresh token](https://developer.spotify.com/documentation/web-api/tutorials/code-flow)\n* Middleware de autenticação\n* Listagem de artistas mais ouvidos\n* Listagem de álbuns de um artista específico\n* Criação e listagem de playlists do usuário\n* Exibição do perfil do usuário\n* Paginação de resultados\n\n### Endpoints disponíveis\n\n```dir\n\u003croot\u003e\n├── auth\n│   ├── login           # [GET]  /auth/login               (Generate Spotify login URL)\n│   ├── callback        # [GET]  /auth/callback            (Handle Spotify callback)\n│   ├── logout          # [GET]  /auth/logout              (Logout user)\n│   └── refresh         # [POST] /auth/refresh             (Refresh access token)\n├── user\n│   └── profile         # [GET]  /user/profile             (Get user profile)\n├── artist\n│   ├── me\n│   │   └── top-artists # [GET]  /artist/me/top-artists    (Get top artists)\n│   └── \u003cartistId\u003e\n│       └── albums      # [GET]  /artist/\u003cartistId\u003e/albums (Get artist albums)\n├── playlist\n│   ├── me              # [GET]  /playlist/me              (Get user playlists)\n│   └── me              # [POST] /playlist/me              (Create a new playlist)\n├── status              # [GET]  /status                   (Check if the API is running)\n├── \u003c404\u003e               # [ANY]  /\u003cpath\u003e                   (Catch-all for undefined routes)\n└── \u003c500\u003e               # [ANY]  /\u003cpath\u003e                   (Catch-all for server errors)\n```\n\n## 📂 Estrutura de pastas\n\n```dir\nsrc\n├── routes\n│   ├── auth     # fluxo de autenticação\n│   ├── user     # perfil\n│   ├── artist   # artistas mais ouvidos e álbuns de um artista\n│   └── playlist # criação e listagem de playlists\n├── middleware   # autenticação, erros, logging\n├── functions    # funções auxiliares\n└── tests        # testes unitários\n```\n\n## ✅ Checklist de requisitos\n\n### Requisitos obrigatórios\n\n* [x] Segmentação de commits\n* [x] Lint\n* [x] Autenticação via Spotify\n* [x] Listar artistas\n* [x] Listar álbuns de um artista\n* [x] Utilizar paginação (scroll infinito ou não) - Frontend\n* [x] Funcionamento offline - Frontend\n* [x] Testes unitários\n* [x] Deploy da aplicação\n\n### Bônus\n\n* [ ] Testes E2E\n* [ ] CI/CD (CI não implementado, CD implementado via Fly.io)\n* [ ] Responsividade\n* [ ] Qualidade de código (SonarQube)\n* [ ] PWA\n\n### Outros critérios\n\n* [x] Exibir perfil do usuário\n* [x] Criar playlists para o usuário\n* [x] Listar playlists do usuário\n* [x] Documentação da API\n\n## ⚙️ Como executar localmente\n\n### 1. Clonar o repositório\n\n```bash\ngit clone https://github.com/GeisonJr/spotify-api.git\ncd spotify-api\n```\n\n### 2. Criar arquivo `.env` com variáveis\n\n\u003e ⚠ As credenciais do Spotify devem ser configuradas no [Spotify Developer Dashboard](https://developer.spotify.com/dashboard), garantindo que a Redirect URI seja exatamente a informada abaixo.\n\n```env\nSPOTIFY_CLIENT_ID=seu_client_id\nSPOTIFY_CLIENT_SECRET=seu_client_secret\nSPOTIFY_REDIRECT_URI=http://localhost:3000/callback\nFRONTEND_URL=http://localhost:5555\n```\n\n### 3. Instalar dependências\n\n```bash\nnpm install\n```\n\n### 4. Rodar em modo desenvolvimento\n\n```bash\nnpm run dev\n```\n\n### 5. Executar testes\n\n```bash\nnpm run test\n# ou\nnpm run test:coverage\n```\n\n## 📦 Deploy\n\nO deploy está configurado via **Fly.io**.\nPara publicar alterações:\n\n```bash\nfly deploy\n```\n\n## 📄 Decisões de arquitetura\n\n* **Documentação OpenAPI** para fácil entendimento e integração com a API.\n* **Estrutura de pastas organizada** para facilitar a navegação e manutenção do código, com separação clara entre rotas, middleware, funções auxiliares e testes.\n* **Separação por contexto**: cada módulo (`auth`, `user`, `artist`, `playlist`) mantém rotas, controladores e serviços isolados, favorecendo manutenção e escalabilidade.\n* **TypeScript** para tipagem forte e prevenção de erros em tempo de desenvolvimento.\n* **Express.js** como framework HTTP, proporcionando simplicidade e flexibilidade.\n* **Middlewares reutilizáveis** para autenticação, logs e tratamento de erros.\n* **Uso de variáveis de ambiente** para configuração sensível, evitando hardcoding de credenciais.\n* **Docker** para containerização, garantindo consistência entre ambientes de desenvolvimento e produção.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeisonjr%2Fspotify-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeisonjr%2Fspotify-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeisonjr%2Fspotify-api/lists"}