{"id":20770324,"url":"https://github.com/vilarimlucas/exc-task-list-api","last_synced_at":"2026-04-12T06:31:47.146Z","repository":{"id":261618763,"uuid":"884771852","full_name":"VilarimLucas/exc-task-list-api","owner":"VilarimLucas","description":"API desenvolvida na aula de Teste e qualidade de Software com os elementos do widget Task List do projeto EX Ctrl","archived":false,"fork":false,"pushed_at":"2024-11-14T21:51:43.000Z","size":281,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T19:48:42.448Z","etag":null,"topics":["express-js","jest-test","node-js","nodemon-express","npm","sequelize-cli","supertest","swagger-ui"],"latest_commit_sha":null,"homepage":"https://vilarimlucas.github.io/exc-task-list-api/docs.html","language":"JavaScript","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/VilarimLucas.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-11-07T11:09:48.000Z","updated_at":"2024-11-14T21:51:47.000Z","dependencies_parsed_at":"2025-01-18T07:10:13.452Z","dependency_job_id":"8d76674f-691d-4628-a660-ef0ee177bf47","html_url":"https://github.com/VilarimLucas/exc-task-list-api","commit_stats":null,"previous_names":["vilarimlucas/exc-task-list-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/VilarimLucas/exc-task-list-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VilarimLucas%2Fexc-task-list-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VilarimLucas%2Fexc-task-list-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VilarimLucas%2Fexc-task-list-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VilarimLucas%2Fexc-task-list-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VilarimLucas","download_url":"https://codeload.github.com/VilarimLucas/exc-task-list-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VilarimLucas%2Fexc-task-list-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28021587,"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-12-25T02:00:05.988Z","response_time":58,"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":["express-js","jest-test","node-js","nodemon-express","npm","sequelize-cli","supertest","swagger-ui"],"created_at":"2024-11-17T12:08:42.810Z","updated_at":"2025-12-25T06:07:42.542Z","avatar_url":"https://github.com/VilarimLucas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# exc-task-list-api   \n\nAPI desenvolvida na aula de Teste e qualidade de Software com os elementos do widget Task List do projeto EX Ctrl \n\n\n## Tecnologias Utilizadas\n\n![Node.js](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge\u0026logo=node.js\u0026logoColor=white)\n![Express](https://img.shields.io/badge/Express-000000?style=for-the-badge\u0026logo=express\u0026logoColor=white)\n![Sequelize](https://img.shields.io/badge/sequelize-323330?style=for-the-badge\u0026logo=sequelize\u0026logoColor=blue)\n![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge\u0026logo=mysql\u0026logoColor=white)\n![Swagger](https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge\u0026logo=swagger\u0026logoColor=black)\n![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge\u0026logo=jest\u0026logoColor=white)\n![Nodemon](https://img.shields.io/badge/Nodemon-76D04B?style=for-the-badge\u0026logo=nodemon\u0026logoColor=white)\n![Supertest](https://img.shields.io/badge/Supertest-000000?style=for-the-badge)\n\n## Requisitos\n\n- ![Nodejs](https://img.shields.io/badge/Nodejs-3C873A?style=for-the-badge\u0026labelColor=black\u0026logo=node.js\u0026logoColor=3C873A) (versão mínima recomendada: 14.x)\n- ![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge\u0026logo=npm\u0026logoColor=white) (ou **yarn**) instalado\n- ![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge\u0026logo=mysql\u0026logoColor=white) rodando localmente ou em um serviço de nuvem\n\n## Instalação\n\n1. Clone o repositório:\n\n   ```bash\n   git clone https://github.com/VilarimLucas/exc-task-list-api.git\n   cd exc-task-list-api\n   ```\n\n2. Instale as dependências: \n\n   ```bash\n   npm install\n   ```\n\n## Scripts disponíveis\n\nNo arquivo package.json, os seguintes scripts estão disponíveis:\n\n- npm run dev1: Executa o servidor no modo de desenvolvimento com nodemon, reiniciando automaticamente ao detectar mudanças.\n\n```bash\nnpm run dev1\n```\n\n- npm run dev2: Executa o servidor no modo de desenvolvimento com o comando --watch do próprio NODE, reiniciando automaticamente ao detectar mudanças.\n\n```bash\nnpm run dev2\n```\n\n- npm run build: Executa o servidor em modo de produção (sem nodemon).\n\n```bash\nnpm run build\n```\n\n- npm run test: Executa os testes unitários utilizando o Jest.\n\n```bash\nnpm run test\n```\n\n## ![Swagger](https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge\u0026logo=swagger\u0026logoColor=white) Gerando a Documentação com Swagger\n\nEste projeto utiliza swagger-jsdoc para gerar a documentação da API a partir de anotações no código.\n\n### Gerando o arquivo swagger.json\n\nAntes de gerar a documentação completa, você precisa criar o arquivo swagger.json a partir das anotações JSDoc nas rotas. Um script foi configurado para facilitar esse processo.\n\n1. Execute o script para gerar o swagger.json:\n\n   ```bash\n   node generate-swagger-json.js\n   ```\n\n## Gerando o arquivo docs.html com ReDoc\nCom o arquivo swagger.json gerado, você pode criar a documentação em formato HTML utilizando o ReDoc.\n\n2. Para gerar o arquivo docs.html, execute o seguinte comando:\n\n   ```bash\n   npx @redocly/cli build-docs swagger.json -o docs.html\n   ```\n\n   ### Acessando a Documentação\n\n   Após gerar o arquivo `docs.html`, você pode visualizá-lo abrindo o arquivo no navegador.\n   \n   A documentação da API também está disponível online através do GitHub Pages. Você pode acessá-la no seguinte link:\n   \n   [Documentação da API](https://vilarimlucas.github.io/exc-task-list-api/docs.html)\n   \n### Licença\n\nEste projeto está licenciado sob a licença ISC. Veja o arquivo LICENSE para mais detalhes.\n\n\n### Explicação do conteúdo do `README.md`:\n\n1. **Introdução**: Descreve o projeto e o objetivo.\n2. **Requisitos**: Indica o que é necessário para rodar o projeto.\n3. **Instalação**: Instruções sobre como clonar o repositório e instalar as dependências.\n4. **Scripts disponíveis**: Explica os comandos disponíveis no `package.json` para rodar o servidor em desenvolvimento, produção e rodar os testes.\n5. **Gerando a documentação**: Explica como gerar o `swagger.json` e o `docs.html` usando os scripts e o Redoc.\n6. **Acessando a documentação**: Informa que o arquivo `docs.html` pode ser configurado para ser servido no GitHub Pages e cria um espaço para o link.\n7. **Contribuindo**: Um espaço para encorajar contribuições ao projeto.\n\nCom esse `README.md`, qualquer pessoa que pegar o projeto saberá como rodá-lo, gerar a documentação e visualizá-la.\n\nSe precisar de mais alguma coisa ou algum ajuste, é só me avisar!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvilarimlucas%2Fexc-task-list-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvilarimlucas%2Fexc-task-list-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvilarimlucas%2Fexc-task-list-api/lists"}