{"id":24560440,"url":"https://github.com/luifean/todo-list-api","last_synced_at":"2026-05-18T18:39:02.883Z","repository":{"id":273702578,"uuid":"913071862","full_name":"LuiFeAn/todo-list-api","owner":"LuiFeAn","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-22T12:47:45.000Z","size":200,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-22T13:43:02.387Z","etag":null,"topics":["authentication","authorization","clean-architecture","clean-code","jwt","nestjs","rest","swagger","tdd","todolist"],"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/LuiFeAn.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":"2025-01-07T01:20:03.000Z","updated_at":"2025-01-22T12:55:54.000Z","dependencies_parsed_at":"2025-01-22T13:53:12.255Z","dependency_job_id":null,"html_url":"https://github.com/LuiFeAn/todo-list-api","commit_stats":null,"previous_names":["luifean/todo-list-api-clean-arch"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuiFeAn%2Ftodo-list-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuiFeAn%2Ftodo-list-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuiFeAn%2Ftodo-list-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuiFeAn%2Ftodo-list-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LuiFeAn","download_url":"https://codeload.github.com/LuiFeAn/todo-list-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243933384,"owners_count":20370988,"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":["authentication","authorization","clean-architecture","clean-code","jwt","nestjs","rest","swagger","tdd","todolist"],"created_at":"2025-01-23T07:16:48.717Z","updated_at":"2026-05-18T18:39:02.838Z","avatar_url":"https://github.com/LuiFeAn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NestJS App - Guia de Uso e Configuração\n\nApesar de não ser necessário para o contexto de um todo-list simples, desenvolvi este projeto utilizando a arquitetura Hexagonal/Clean Architecture, simulando uma API que poderia ser mais escalável. Assim, priorizando facilidade de manutenção e independência de detalhes técnicos como frameworks e banco de dados\n\n## Documentação dos Endpoints (Swagger)\n\nAcesse `http://localhost:{API_PORT}/swagger`\n\n## Pré-requisitos\n\nCertifique-se de ter os seguintes itens instalados:\n\n- [Node.js](https://nodejs.org) (recomendado: última versão LTS)\n- [pnpm](https://pnpm.io/installation) (para gerenciamento de pacotes)\n- [Docker](https://www.docker.com) e [Docker Compose](https://docs.docker.com/compose/) (para executar com containers, se necessário)\n\n---\n\n## Rodando o Projeto\n\n### Modo Desenvolvimento\n\nPara iniciar o servidor no modo de desenvolvimento, utilize o comando:\n\n```bash\npnpm start:dev\n```\n\nO servidor estará disponível na porta configurada pela variável `API_PORT` (por padrão, 3000).\n\n---\n\n### Modo Build\n\nPara executar a aplicação em modo de produção:\n\n1. Compile a aplicação:\n\n   ```bash\n   pnpm build\n   ```\n\n2. Inicie o servidor:\n\n   ```bash\n   pnpm start:prod\n   ```\n\nO servidor estará disponível na porta configurada pela variável `API_PORT` (por padrão, 3000).\n\n---\n\n### Executando Testes Unitários\n\nOs testes unitários podem ser executados com o comando:\n\n```bash\npnpm test:unit\n```\n\n---\n\n### Modo Docker Compose\n\nCaso prefira utilizar Docker Compose:\n\n1. Suba os containers:\n\n   ```bash\n   docker compose up -d\n   ```\n\n2. Acesse a aplicação em `http://localhost:{API_PORT}`.\n\nPara parar os containers:\n\n```bash\ndocker compose down\n```\n\n---\n\n## Configuração de Ambiente\n\nCrie um arquivo `.env` na raiz do projeto com as seguintes variáveis:\n\n```\n\nDB_NAME=example\nDB_HOST=127.0.0.1\nDB_PORT=3306\nDB_USER=root\nDB_PASS=1234\n\nAPI_PORT=3000\nJWT_SECRET_KEY=12345\n```\n\nPara referência, consulte o arquivo `.env.example`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluifean%2Ftodo-list-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluifean%2Ftodo-list-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluifean%2Ftodo-list-api/lists"}