{"id":13606577,"url":"https://github.com/AdilsonFuxe/auth-microservice","last_synced_at":"2025-04-12T08:31:41.375Z","repository":{"id":175175244,"uuid":"395192154","full_name":"AdilsonFuxe/auth-microservice","owner":"AdilsonFuxe","description":"Authentication microservice built with Node.js that follows Clean Architecture + TDD + SOLID + DDD + functional programming principles","archived":false,"fork":false,"pushed_at":"2023-01-03T21:25:41.000Z","size":680,"stargazers_count":59,"open_issues_count":2,"forks_count":17,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-07T11:44:31.269Z","etag":null,"topics":["clean-architecture","ddd","docker","docker-compose","k8s","kubernetes","nodejs","nodemailer","solid","stateful-components","swagger","tdd","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/AdilsonFuxe.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}},"created_at":"2021-08-12T04:17:36.000Z","updated_at":"2024-11-04T14:05:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"e9ff0364-42a8-48fe-8d5a-ab2e6833ba1f","html_url":"https://github.com/AdilsonFuxe/auth-microservice","commit_stats":null,"previous_names":["adilsonfuxe/auth-microservice"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdilsonFuxe%2Fauth-microservice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdilsonFuxe%2Fauth-microservice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdilsonFuxe%2Fauth-microservice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdilsonFuxe%2Fauth-microservice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AdilsonFuxe","download_url":"https://codeload.github.com/AdilsonFuxe/auth-microservice/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248539917,"owners_count":21121259,"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":["clean-architecture","ddd","docker","docker-compose","k8s","kubernetes","nodejs","nodemailer","solid","stateful-components","swagger","tdd","typescript"],"created_at":"2024-08-01T19:01:10.366Z","updated_at":"2025-04-12T08:31:36.364Z","avatar_url":"https://github.com/AdilsonFuxe.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp\u003e\n  \u003cimg alt=\"Build Status\" src=\"https://travis-ci.com/AdilsonFuxe/clean-auth-microservice.svg?branch=main\"\u003e\n  \u003cimg alt=\"Coverage Status\" src=\"https://coveralls.io/repos/github/AdilsonFuxe/clean-auth-microservice/badge.svg?branch=main\"\u003e\n   \u003cimg alt=\"Auth Microservice\" src=\"https://img.shields.io/static/v1?label=Auth%20Microservice\u0026message=V1\u0026color=8257E5\u0026labelColor=000000\"\u003e\n   \u003cimg alt=\"License\" src=\"https://img.shields.io/badge/license-MIT-brightgreen\"\u003e\n\u003c/p\u003e\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/othneildrew/Best-README-Template\"\u003e\n  \u003c/a\u003e\n\n\u003ch1 align=\"center\"\u003eNode.js Authentication Microservice\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n   A simple API built with Node.js that follows Clean Architecture + TDD + SOLID + DDD principles\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [About The Project](#about-the-project)\n  - [Built With](#built-with)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Endpoints](#endpoints)\n  - [SignUp](#signup)\n  - [SignIn](#signin)\n  - [Forgot Password](#forgot-password)\n  - [Reset Password](#reset-password)\n  - [me](#me)\n  - [signout](#signout)\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n### Built With\n\n- [NodeJs](https://nodejs.org/)\n- [Typescript](https://https://www.typescriptlang.org/)\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nto run the project you need to have npm installed on your machine and\nthe mongo DB\n\n### Prerequisites\n\nto get the npm https://www.npmjs.com/get-npm\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/AdilsonFuxe/clean-auth-microservice.git\n```\n\n2. Server configuration\n\nEnter into the server folder\n\n```sh\ncd clean-auth-microservice\n```\n\n3. inside the server folder run the following command to install all dependencies\n\n```sh\nnpm install or yarn\n```\n\n4. to generate the build of the project run\n\n```sh\nnpm run build or yarn build\n```\n\n5. to run the server\n\n```sh\nnpm start or yarn start\n```\n\n6. to run the unit tests and the integration tests\n\n```sh\nnpm test or yarn test\n```\n\n\u003cbr/\u003e\n\n## Endpoints\n\n\u003cbr/\u003e\n\n### SignUp\n\n**POST** `https:/localhost/api/v1/signup`\n\n##### output example\n\n```json\n// POST https:/localhost/api/v1/signup\n\n// Request Body\n{\n  \"firstName\": \"any_name\",\n  \"lastName\": \"any_name\",\n  \"email\": \"anyemail@mail.com\",\n  \"password\": \"any_password\",\n  \"passwordConfirmation\": \"any_password\"\n}\n\n// Response Body\n{\n  \"accessToken\": \"any_access_token\"\n}\n```\n\n\u003cbr/\u003e\n\n### SignIn\n\n**POST** `https:/localhost/api/v1/signin`\n\n##### output example\n\n```json\n// POST https:/localhost/api/v1/signin\n\n// Request Body\n{\n  \"email\": \"any_mail@mail.com\",\n  \"password\": \"any_password\"\n}\n\n// Response Body\n{\n  \"accessToken\": \"any_access_token\"\n}\n```\n\n\u003cbr/\u003e\n\n### Me\n\n**GET** `https:/localhost/api/v1/me`\n\n##### output example\n\n```json\n// Get https:/localhost/api/v1/me\n// HEADER x-access-token = any_access_token\n\n// Response Body\n{\n  \"id\": \"any_id\",\n  \"firstName\": \"any_name\",\n  \"lastName\": \"any_name\",\n  \"email\": \"anyemail@mail.com\"\n}\n```\n\n\u003cbr/\u003e\n\n### Forgot Password\n\n**Patch** `https:/localhost/api/v1/forgot`\n\n##### output example\n\n```json\n// Patch https:/localhost/api/v1/forgot\n\n// Request Body\n{\n  \"email\": \"any_mail@mail.com\"\n}\n```\n\n\u003cbr/\u003e\n\n### Reset Password\n\n**Patch** `https:/localhost/api/v1/reset-password`\n\n##### output example\n\n```json\n// Patch https:/localhost/api/v1/reset-password\n\n// Request Body\n{\n  \"email\": \"any_mail@mail.com\",\n  \"accessToken\": 092498,\n  \"password\": \"new_password\"\n}\n```\n\n\u003cbr/\u003e\n\n### Signout\n\n**Delete** `https:/localhost/api/v1/signout`\n\n##### output example\n\n```json\n// Delete https:/localhost/api/v1/signout\n// HEADER x-access-token = any_access_token\n\n// Request Body\nStatus Code 204\n{}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAdilsonFuxe%2Fauth-microservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAdilsonFuxe%2Fauth-microservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAdilsonFuxe%2Fauth-microservice/lists"}