{"id":19501355,"url":"https://github.com/devphde/authentication-api","last_synced_at":"2026-04-10T04:42:19.954Z","repository":{"id":156653426,"uuid":"630195511","full_name":"DevPhde/authentication-api","owner":"DevPhde","description":"Authentication-API","archived":false,"fork":false,"pushed_at":"2023-05-06T03:47:06.000Z","size":188,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T19:32:42.913Z","etag":null,"topics":["docker","express-js","nodejs","postgresql","redis","sequelize-orm","solid-principles","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DevPhde.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-04-19T21:47:43.000Z","updated_at":"2023-05-12T19:31:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"7e15dcf5-f1f8-4230-8ada-dc7e01ebc0a9","html_url":"https://github.com/DevPhde/authentication-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DevPhde/authentication-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevPhde%2Fauthentication-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevPhde%2Fauthentication-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevPhde%2Fauthentication-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevPhde%2Fauthentication-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevPhde","download_url":"https://codeload.github.com/DevPhde/authentication-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevPhde%2Fauthentication-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001959,"owners_count":26083244,"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-10-09T02:00:07.460Z","response_time":59,"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":["docker","express-js","nodejs","postgresql","redis","sequelize-orm","solid-principles","typescript"],"created_at":"2024-11-10T22:12:25.844Z","updated_at":"2025-10-09T19:33:30.515Z","avatar_url":"https://github.com/DevPhde.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Authentication-API\n\n## :memo: Descrição do projeto\nEste é um projeto criado utilizando as tecnologias Node e TypeScript, com o objetivo de demonstrar minhas habilidades em abstração, Programação Orientada a Objetos (POO), princípios SOLID, CLEAN CODE e Domain-Driven Design (DDD).\n\nA API desenvolvida neste projeto tem como funcionalidades registrar usuários, autenticar (login) do usuário e recuperar senha do usuário. Para implementar essas funcionalidades, o projeto utiliza o Redis como um mecanismo temporário de armazenamento de tokens para a recuperação de senha do usuário e o PostgreSQL como banco de dados para persistência dos dados do usuário.\n\nTambém foi implementada uma funcionalidade de envio de e-mails utilizando a biblioteca Nodemailer.\n\nPara facilitar o gerenciamento e a execução do projeto, foi utilizado o Docker, com a criação de imagens para o Redis e o PostgreSQL. O Docker Compose foi utilizado para rodar a aplicação de forma simples e rápida.\n\nCom este projeto, busquei criar uma estrutura limpa e escalável, seguindo as melhores práticas de desenvolvimento e utilizando tecnologias modernas e confiáveis para garantir a qualidade e a segurança do software.\n## :wrench: Tecnologias Utilizadas\n\nExpress.js, TypeScript, PostgreSQL, Redis e Docker. \n\n\u003cimg align=\"left\" height=\"50em\" src=\"https://www.edureka.co/blog/wp-content/uploads/2019/07/express-logo.png\" /\u003e\n\u003cimg align=\"left\" height=\"50em\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/typescript/typescript-original.svg\" /\u003e\n\u003cimg align=\"left\" height=\"50em\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/postgresql/postgresql-plain-wordmark.svg\" /\u003e\n\u003cimg align=\"left\" height=\"50em\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/redis/redis-original-wordmark.svg\" /\u003e\n\u003cimg align=\"left\" height=\"50em\" src=\"https://cdn.jsdelivr.net/gh/devicons/devicon/icons/docker/docker-original.svg\" /\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\n## :rocket: Implementação futura\n* Sem planos futuros para o mesmo.\n\n## Como Rodar o Projeto\nObservação: Para rodar o projeto é necessário ter o Docker instalado e configurado na máquina.\n\nObservação²: Para que a funcionalidade de envio de emails funcione corretamente, é necessário configurar as variáveis de ambiente `MAILTRAP_USER`,  `MAILTRAP_PASSWORD` e `MAILTRAP_MAIL` no arquivo `docker-compose.yml` com as credenciais da sua conta no Mailtrap. Dessa forma, você poderá visualizar os emails enviados na caixa de entrada da sua conta e testar essa funcionalidade.\n\n```\nenvironment:\n      NODE_ENV: development\n      JWT_SECRET: chavesecreta\n      PORT: 3002\n      MAILTRAP_HOST: sandbox.smtp.mailtrap.io\n      MAILTRAP_USER: SEU USUÁRIO\n      MAILTRAP_PASSWORD: SUA SENHA\n      MAILTRAP_MAIL: SEU EMAIL\n      REDIS_HOST: redis\n      POSTGRES_HOST: db\n      POSTGRES_USER: postgres\n      POSTGRES_PASSWORD: password\n      POSTGRES_DB: postgres\n```\n\n\nPara executar o projeto, siga os passos abaixo:\n\n1. Abra o terminal e navegue até a pasta raiz do projeto.\n\n2. Execute o seguinte comando:\n```\ndocker-compose up\n```\nEsse comando irá gerar as imagens do Redis e do PostgreSQL e inicializará o servidor na porta 3002.\n\nObservação: É importante lembrar que a primeira execução do comando pode levar alguns minutos, pois o Docker precisa baixar as imagens necessárias para o projeto.\n\n3. Acesse o servidor através do endereço `http://localhost:3002`.\n\nCom esses passos, o projeto deverá estar rodando corretamente na sua máquina.\n\n## Documentação dos Endpoints\n\n\u003cdetails\u003e\u003csummary\u003e(POST) \u003cstrong\u003e/new/user\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003eResponsável por criar novo usuário.\u003c/b\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\u003cbr/\u003e\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"name\": \"nome completo\",\n\t\"cpf\": \"123.456.789-01\",\n\t\"email\": \"teste@teste.com\",\n\t\"password\": \"123\"\n}\n```\n\nResponse:\n\nHTTP CODE: 201\n\n\u003cbr/\u003e\nBody\n\n```\nOK\n```\n\nHTTP CODE: 401\n\nCaso CPF ou email já esteja cadastrado.\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"message\": \"CPF  e  Email Já cadastrado.\"\n} \n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n\u003cdetails\u003e\u003csummary\u003e(POST) \u003cstrong\u003e/user/login\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003eResponsável por autenticar(fazer login) de usuário cadastrado.\u003c/b\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\u003cbr/\u003e\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"email\": \"teste@teste.com\",\n\t\"password\": \"123\"\n}\n```\n\nResponse:\n\nHTTP CODE: 200\n\n\u003cbr/\u003e\nBody\n\n```\n{\n\t\"jwt\": HASH JWT\n}\n```\n\nHTTP CODE: 401\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"message\": \"Email or Password Invalid\"\n} \n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n\u003cdetails\u003e\u003csummary\u003e(POST) \u003cstrong\u003e/user/recoverypassword\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003e1º Passo para recuperação de senha do usuário. \n\n - Gera um token e envia para o email cadastrado.\u003c/b\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\u003cbr/\u003e\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"email\": \"teste@teste.com\",\n}\n```\n\nResponse:\n\nHTTP CODE: 200\n\n```\n{\n\t\"jwt\": HASH JWT\n}\n```\n\nHTTP CODE: 401\n\n```\nJSON\n{\n\t\"message\": \"Invalid Email\"\n}\n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n\u003cdetails\u003e\u003csummary\u003e(POST) \u003cstrong\u003e/user/matchtoken\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003e2º Passo para recuperação de senha do usuário. \n\n - Verifica o token que foi enviado por email.\u003c/b\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\n\u003cbr/\u003e\n\u003cbr/\u003e\nHEADER\n\n```\nauthorization: HASH JWT\n```\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"token\": TOKEN RECEBIDO POR EMAIL\n}\n```\n\nResponse:\n\nHTTP CODE: 200\n\n\u003cbr/\u003e\nBody\n\n```\nOK\n```\n\nHTTP CODE: 401\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"message\": \"Invalid Token\"\n}\n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n\u003cdetails\u003e\u003csummary\u003e(PUT) \u003cstrong\u003e/user/recoverypassword/newpassword\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003e3º Passo para recuperação de senha do usuário. \n\n - Troca a senha antiga da conta por uma nova senha.\u003c/b\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\n\u003cbr/\u003e\n\u003cbr/\u003e\nHEADER\n\n```\nauthorization: HASH JWT\n```\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"password\": \"1234\"\n}\n```\n\nResponse:\n\nHTTP CODE: 200\n\n\u003cbr/\u003e\nBody\n\n```\nOK\n```\n\nHTTP CODE: 401\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"message\": \"new password cannot be the same as the old one\"\n}\n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n\u003cdetails\u003e\u003csummary\u003e(GET) \u003cstrong\u003e/user/recoverypassword/resendtoken\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr/\u003e\n\u003cb\u003eFaz parte do 2º passo para recuperação de senha. \n\n - Reenvia o token para o email cadastrado.\u003c/b\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cdiv\u003e\nRequest:\n\u003cbr/\u003e\n\u003cbr/\u003e\nHEADER\n\n```\nauthorization: HASH JWT\n```\n\nResponse:\n\nHTTP CODE: 200\n\n\u003cbr/\u003e\nBody\n\n```\nOK\n```\n\nHTTP CODE: 401\n\n\u003cbr/\u003e\nBody\n\n```\nJSON\n{\n\t\"message\": \"Invalid JWT\"\n}\n```\n\n\u003c/div\u003e\n\n\u003c/details\u003e\u0026nbsp;\n\n## :dart: Status do projeto\nProjeto finalizado.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevphde%2Fauthentication-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevphde%2Fauthentication-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevphde%2Fauthentication-api/lists"}