{"id":22226357,"url":"https://github.com/trkotovicz/todos-nest","last_synced_at":"2026-04-12T01:33:51.093Z","repository":{"id":228657243,"uuid":"774083541","full_name":"trkotovicz/todos-nest","owner":"trkotovicz","description":"API com as principais funcionalidades de um gerenciador de tarefas","archived":false,"fork":false,"pushed_at":"2024-03-22T02:49:19.000Z","size":465,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T08:37:07.710Z","etag":null,"topics":["api-rest","docker","e2e-testing","jest","jwt-authentication","mysql","nestjs","nodejs","supertest","swagger","typeorm","typescript","unit-testing"],"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/trkotovicz.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-03-18T23:08:13.000Z","updated_at":"2024-03-22T02:50:08.000Z","dependencies_parsed_at":"2024-03-19T21:28:42.446Z","dependency_job_id":"c9f145ea-37d6-4039-90db-68f9bc7c2baf","html_url":"https://github.com/trkotovicz/todos-nest","commit_stats":null,"previous_names":["trkotovicz/todos-nest"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/trkotovicz/todos-nest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trkotovicz%2Ftodos-nest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trkotovicz%2Ftodos-nest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trkotovicz%2Ftodos-nest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trkotovicz%2Ftodos-nest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trkotovicz","download_url":"https://codeload.github.com/trkotovicz/todos-nest/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trkotovicz%2Ftodos-nest/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31701641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"ssl_error","status_checked_at":"2026-04-11T21:17:24.556Z","response_time":54,"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":["api-rest","docker","e2e-testing","jest","jwt-authentication","mysql","nestjs","nodejs","supertest","swagger","typeorm","typescript","unit-testing"],"created_at":"2024-12-03T00:28:18.690Z","updated_at":"2026-04-12T01:33:51.076Z","avatar_url":"https://github.com/trkotovicz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ToDo App\n\nToDo App é uma API com as principais funcionalidades de um gerenciador de tarefas.\n\n## Sobre a aplicação\n\n- A aplicação foi construída utilizando Node.JS, Typescript e o framework [Nest.JS](https://docs.nestjs.com/).\n- O ORM escolhido foi o [TypeORM](https://typeorm.io/).\n- O banco é o [MySQL](https://www.mysql.com/)\n- As rotas são protegidas no padrão [Bearer Authentication](https://swagger.io/docs/specification/authentication/bearer-authentication).\n\n## Requisitos\n\nUma pessoa deseja se cadastrar para usufruir do gerenciador de tarefas:\n- Pessoa precisa estar autenticada.\n- Pessoa pode ter várias tarefas.\n- Não pode haver tarefas repetidas.\n\n## Funcionalidades\n\n- **Criar uma pessoa:** o `username` deve ser único.\n\t- Listar usuários.\n\t- Excluir usuário.\n\t- Editar usuário.\n- **Adicionar uma tarefa**: `task` deve ser único.\n\t- Listar tarefas.\n\t- Excluir tarefas.\n\t- Editar tarefas.\n\n## Variáveis de Ambiente\n\nPara usar a aplicação, você precisará configurar as variáveis ​​de ambiente.\nRenomeie o arquivo raiz do projeto `.env.example` para `.env`. Este arquivo contém todas as variáveis ​​necessárias para iniciar o aplicativo.\n\n⚠️ **Importante**\nVocê deve substituir as informações do arquivo pelas credenciais do seu banco de dados.\nAlém disso, na variável `MYSQL_HOST` você precisará informar `localhost` para rodar o projeto **localmente**, ou `mysql` para rodar a aplicação via **Docker**.\nExemplo:\n```bash\nMYSQL_HOST=mysql # Para rodar pelo Docker\nMYSQL_HOST=localhost # Para rodar localmente\nMYSQL_USER=root\nMYSQL_PASSWORD=root\n```\n\n## Inicialização da Aplicação\n\n### Inicialização via Docker 🐳\n\n1. Clone o repositório `git@github.com:trkotovicz/todos-nest.git`.\n2. Na raíz do repositório, abra o terminal e rode o comando `npm run compose:up` e aguarde a alicação subir (esse passo pode demorar um pouco).\n3. Para encerrar a aplicação, rode o comando `npm run compose:down`.\n\n### Inicialização local 🖥\n\n1. Clone o repositório `git@github.com:trkotovicz/todos-nest.git`.\n2. Na raíz do repositório instale as dependências:\n\t```bash\n\t$ npm install\n\t```\n3. Configure as variáveis de ambiente no arquivo `.env`\n4. Inicialize o projeto:\n\t```bash\n\t$ npm start\n\t```\n\n\n## API\n\nCom a aplicação rodando acesse a [documentação da API](http://localhost:3001/docs/#/). \u003c/br\u003e\n \n### ⚠️ Rotas protegidas\n\nAs ações devem ser realizadas com a conta da pessoa autenticada.\nO token retornado do login deve ser enviado no header com o nome de `Authorization`.\n\n Exemplo:\n ```\n Authorization: Bearer {TOKEN_AQUI}\n ```\n \n\n## Banco de Dados\n\nO aplicativo usa o banco de dados MySQL. Certifique-se de tê-lo instalado em seu computador caso queira rodar a aplicação **localmente**. A aplicação possui os scripts necessários para criar ou excluir o banco de dados.\n\n_**Ao iniciar a aplicação, o banco de dados será criado automaticamente.**_\n\nScripts:\n- `npm run db:create` para criar seu banco de dados.\n- `npm run db:drop` para excluir o banco de dados.\n\n \n\u003c/br\u003e\n\n\n## Testes\n\nA aplicação possui testes unitários e testes de integração (E2E).\nPara isso, foi utilizado Jest e Supertest.\n\n```bash\n# tests\nnpm test\n\n# coverage\nnpm run test:cov\n```\n\n \n\u003c/br\u003e\n\n \n ---\n\nProjeto desenvolvido por [Thais R Kotovicz](https://www.linkedin.com/in/thaiskotovicz/).\n\u003c/br\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrkotovicz%2Ftodos-nest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrkotovicz%2Ftodos-nest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrkotovicz%2Ftodos-nest/lists"}