{"id":19408603,"url":"https://github.com/4lessandrodev/rest-api","last_synced_at":"2026-04-21T05:33:41.248Z","repository":{"id":63362343,"uuid":"531509586","full_name":"4lessandrodev/rest-api","owner":"4lessandrodev","description":"template for rest api","archived":false,"fork":false,"pushed_at":"2025-02-24T01:26:31.000Z","size":2805,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-11T20:13:54.703Z","etag":null,"topics":["express","nestjs","nodejs-api","rest-api","template"],"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/4lessandrodev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-09-01T12:29:52.000Z","updated_at":"2025-02-24T01:26:28.000Z","dependencies_parsed_at":"2023-02-16T12:45:46.564Z","dependency_job_id":"1703e942-a759-4d3f-a18b-dd95390889c5","html_url":"https://github.com/4lessandrodev/rest-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/4lessandrodev/rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4lessandrodev%2Frest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4lessandrodev%2Frest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4lessandrodev%2Frest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4lessandrodev%2Frest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/4lessandrodev","download_url":"https://codeload.github.com/4lessandrodev/rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4lessandrodev%2Frest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32078959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T02:38:07.213Z","status":"ssl_error","status_checked_at":"2026-04-21T02:38:06.559Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","nestjs","nodejs-api","rest-api","template"],"created_at":"2024-11-10T12:06:44.839Z","updated_at":"2026-04-21T05:33:41.226Z","avatar_url":"https://github.com/4lessandrodev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Template - Rest Api\n\nEste template possui comandos automatizados para gerar componentes para a construção do backend.\nOs comandos podem ser executados com:\n\n- `yarn` \n- `npm`\n\n---\n\n## Como utilizar a cli\n\nAntes de tudo instale as dependências\n\n\n```sh\n\n$ yarn\n\n```\n\nUtilizando a cli com yarn\n\n\n```sh\n\n$ yarn types-ddd\n\n```\n![](docs/print.png)\n\nUtilizando a cli com npm\n\n```sh\n\n$ npm run types-ddd\n\n```\n\n---\n\n## Gerenciador de pacotes\n\nPara instalar e gerenciar novos pacotes (libs) utilize yarn.\n\nDependência de produção\n\n```sh\n\n$ yarn add \u003cpackage-name\u003e\n\n```\n\nDependência de desenvolvimento\n\n```sh\n\n$ yarn add \u003cpackage-name\u003e -D\n\n```\n\n---\n\n## Alias Path\n\nEste template já possui um alias global `@modules` e `@shared` configurado\n\n- `@modules/*` aponta para o caminho `src/modules/*`\n- `@shared/*` aponta para o caminho `src/shared/*`\n\nPara adicionar novos alias siga o modelo nos arquivos: \n- `tsconfig.json`  \n- `jest-e2e.json` \n- `jest.config.json` \n\nA inclusão deve ser feita em todos esses 3 arquivos.\n\n---\n\n## Scripts\n\nTestes. \n\nExecutar testes unitários.\n\nobs: Os teste unitários devem ter o padrão de nome `\u003cfile-name\u003e.spec.ts`\n\n\n```sh\n\n$ yarn test\n\n\n```\n\nExecutar testes de integração.\n\nobs: Os teste de integração devem ter o padrão de nome `\u003cfile-name\u003e.test.ts`\n\n```sh\n\n$ yarn test:e2e\n\n\n```\n\nExecutar a aplicação em watch mode\n\n```sh\n\n$ yarn start:dev\n\n```\n\nExecutar a aplicação\n\n```sh\n\n$ yarn start\n\n```\n\nPara verificar se a aplicação está ok\n\n```\n\nGET http://localhost:3000/healthCheck\n\n```\n\n---\n\n## Documentação\n\nEste template já está configurado com swagger\n\nApós iniciar a aplicação basta acessar o endpoint\n\n```\n\nGET http://localhost:3000/docs\n\n```\n\n---\n\n## Variáveis\n\nAs variáveis de ambiente devem ser definidas no arquivo\n\n`src/shared/env.ts`\n\nApós definir as variáveis no env.ts você pode definí-las no arquivo .env\n\n---\n\n## Commits\n\nOs commits devem seguir a convenção do commit lint\n\n```sh\n\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n\n[optional body]\n\n[optional footer(s)]\n\n```\n- `feat`: nova feature\n- `build`: mudanças que afetam o processo de build \n- `chore`: instalação de lib, ou configuração de ferramentas\n- `ci`: configuração de script ou processos do pipeline\n- `docs`: atualização de documentação\n- `style`: mudanças que afetam o estilo do código, formatação etc\n- `refactor`: alteração ou melhoria de código que não seja bug ou feature\n- `perf`: melhorias de código que melhoram a performance\n- `test`: adicionado testes ou correção de algum\n\nExemplo:\n\n```sh\n\n$ git commit -m \"test (payment): ensure payment confirmation\"\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4lessandrodev%2Frest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F4lessandrodev%2Frest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4lessandrodev%2Frest-api/lists"}