{"id":25022947,"url":"https://github.com/juanjocodedev/auth-nest","last_synced_at":"2025-04-13T07:56:41.729Z","repository":{"id":241621927,"uuid":"804448178","full_name":"JuanjoCodedev/auth-nest","owner":"JuanjoCodedev","description":"🚀 Sistema de autenticación con Google y GitHub, gestión de roles, y extensión de sesión con refresh tokens. 🧑‍🚀","archived":false,"fork":false,"pushed_at":"2025-03-14T21:05:52.000Z","size":186,"stargazers_count":21,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T07:56:34.234Z","etag":null,"topics":["authentication","authentication-backend","github-auth","google-auth","jwt","jwt-token","oauth2","refresh-tokens","roles-management","security"],"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/JuanjoCodedev.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":"2024-05-22T15:54:18.000Z","updated_at":"2025-03-14T21:05:55.000Z","dependencies_parsed_at":"2024-06-02T17:10:31.516Z","dependency_job_id":"d1be61e5-f311-4c19-aa28-53f2bcdf0447","html_url":"https://github.com/JuanjoCodedev/auth-nest","commit_stats":null,"previous_names":["juanjocodedev/auth-nest"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuanjoCodedev%2Fauth-nest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuanjoCodedev%2Fauth-nest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuanjoCodedev%2Fauth-nest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JuanjoCodedev%2Fauth-nest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JuanjoCodedev","download_url":"https://codeload.github.com/JuanjoCodedev/auth-nest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681489,"owners_count":21144700,"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","authentication-backend","github-auth","google-auth","jwt","jwt-token","oauth2","refresh-tokens","roles-management","security"],"created_at":"2025-02-05T14:33:22.743Z","updated_at":"2025-04-13T07:56:41.708Z","avatar_url":"https://github.com/JuanjoCodedev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Proyecto de Registro e Inicio de Sesión con Roles\n\nEste proyecto es una aplicación de autenticación que permite a los usuarios registrarse, iniciar sesión y acceder a recursos basados en roles con permisos especificos. Utiliza PostgreSQL como base de datos.\n\n## Características\n\n- Permite a los usuarios crear una cuenta en el sistema.\n- Los usuarios pueden iniciar sesión en la aplicación utilizando sus credenciales con notificación por correo electrónico para accesos desde dispositivos diferentes a los habituales.\n- Actualización de contraseña con generación automática y opción de actualización manual a través de un enlace en el correo electrónico.\n- Permite asignar roles específicos a los usuarios para gestionar sus permisos y acceso dentro de la aplicación.\n- Las rutas de la aplicación están protegidas según el rol del usuario y el permiso que este tenga, asegurando que solo los usuarios con permisos adecuados puedan acceder a ciertas áreas.\n- Utiliza JSON Web Tokens (JWT) para la autenticación segura de usuarios.\n- Implementa refresh tokens para mantener la sesión activa y permitir una conexión fluida sin necesidad de reautenticación constante.\n- Permite a los usuarios iniciar sesión o registrarse utilizando sus cuentas de Google o Github para una experiencia de autenticación más conveniente.\n- Utiliza Handlebars para generar plantillas de correo electrónico dinámicas, facilitando el envío de correos personalizados y bien formateados.\n\n## Tecnologías Utilizadas\n\n- **Backend**: NestJS.\n- **Base de datos**: PostgreSQL.\n- **Autenticación**: JWT (JSON Web Tokens), Passport.\n- **Hashing de contraseñas**: bcrypt.\n- **Envios de correos electrónicos**: Mailer.\n- **CORS**: Para el manejo de solicitudes entre dominios.\n- **Plantillas de correo electrónico**: Handlebars.\n- **Contenedores**: Docker para el despliegue y gestión de contenedores.\n- **Documentación de API**: Swagger para la generación de documentación de API.\n\n## Requisitos Previos\n\n- Node.js (v14 o superior)\n- PostgreSQL\n- npm o yarn\n- Docker (opcional, pero recomendado para el desarrollo y despliegue con contenedores)\n\n## Instalación\n\n1. Clona el repositorio:\n\n```bash\ngit clone https://github.com/JuanjoCodedev/auth-nest.git\n```\n\n2. Configura la base de datos PostgreSQL y crea un archivo `.dev.env` en la raíz del proyecto con la siguiente configuración:\n\n```env\nNODE_ENV=modo-de-trabajo development | production\n\nLOG_LEVEL=debug | info\n\nPORT=3000\nHOST_DATABASE_DEVELOPMENT=localhost\nPOSTGRES_PORT_DEVELOPMENT=5432\nPOSTGRES_USER_DEVELOPMENT=tu-usuario\nPOSTGRES_PASSWORD_DEVELOPMENT=tu-contraseña\nDATABASE_DEVELOPMENT=nombre-de-tu-base-de-datos\n\nHOST_DATABASE_PRODUCTION=localhost\nPOSTGRES_PORT_PRODUCTION=5432\nPOSTGRES_USER_PRODUCTION=tu-usuario\nPOSTGRES_PASSWORD_PRODUCTION=tu-contraseña\nDATABASE_PRODUCTION=nombre-de-tu-base-de-datos\n\nSECRET_KEY=SECRET_KEY\nEXPIRED_TOKEN=tiempo-expiracion-del-token\nEXPIRED_REFRESH_TOKEN=tiempo-expiracion-del-refresh-token\n\nMAILER_HOST=smtp.gmail.com\nMAILER_PORT=465\nMAILER_SECURE=true\nMAILER_NAME=tu-marca\nMAILER_USER=email-remitente@example.com\nMAILER_PASS=tu-contraseña-app-google\n\nGOOGLE_CLIENT_ID=tu-client-id-google\nGOOGLE_CLIENT_SECRET=tu-client-secret-google\nGOOGLE_CALLBACK_URL=http://localhost:3000/auth/google/callback\n\nGITHUB_CLIENT_ID=tu-client-id-GITHUB\nGITHUB_CLIENT_SECRET=tu-client-secret-GITHUB\nGITHUB_CALLBACK_URL=http://localhost:3000/auth/github/callback\n```\n\n### Observación\n\nSi vas a utiizar Docker en vez de implementar:\n\n```env\nHOST_DATABASE=localhost\n```\n\nse recomienda utilizar:\n\n```env\nHOST_DATABASE_DEVELOPMENT=db\n```\n**Nota:** remplace las variables de entorno del archivo `.dev.env` por las credenciales colocadas en su `docker-compose`:\n\n```env\nHOST_DATABASE_DEVELOPMENT=db\nPOSTGRES_PORT_DEVELOPMENT=5432\nPOSTGRES_USER_DEVELOPMENT=root\nPOSTGRES_PASSWORD_DEVELOPMENT=root\nDATABASE_DEVELOPMENT=root\n```\n\n## Uso\n\n1. Opción A: Ejecución con Docker\n\n- Asegúrate de tener Docker instalado en tu sistema. Puedes descargarlo desde Docker Hub.\n\n- Crea un archivo .dev.env en la raíz del proyecto con la configuración de la base de datos y otras variables de entorno necesarias, si no lo haces no te podra ejecutar el comando correctamente (consulta los pasos de instalación #2 .dev.env sigue los pasos).\n\n- Ejecuta el siguiente comando en la raíz del proyecto para construir y ejecutar los contenedores de Docker:\n\n```bash\ndocker-compose up --build\n```\n\nEsto creará e iniciará los contenedores necesarios para ejecutar la aplicación, incluyendo la base de datos PostgreSQL y la interfaz de administración Adminer, para crear la tabla solo dirigete a la **URL:** localhost:8080.\n\n2. Opción B: Ejecución sin Docker\n\n- Asegúrate de tener PostgreSQL instalado y configurado en tu sistema.\n\n- Crea un archivo .dev.env en la raíz del proyecto con la configuración de la base de datos y otras variables de entorno necesarias (consulta los pasos de instalación #2 .dev.env sigue los pasos).\n\n- Instala las dependencias del proyecto:\n\n```bash\nnpm install\n```\n\n- Inicia el servidor con el siguiente comando para probar el envio de correo electronicos en desarrollo:\n\n```bash\nnpm run build-and-start\n```\n\n- Inicia el servidor con el siguiente comando para desarrollo:\n\n```bash\nnpm run start:dev\n```\n\n3. El servidor estará disponible en `http://localhost:3000` tambien puedes ingesar `http://localhost:3000/api` para el uso de Swagger.\n\n### Endpoints\n\n#### Registro de Usuario\n\n- **URL**: `sign-up/signUp`\n- **Método**: `POST`\n- **Cuerpo**:\n  ```json\n  {\n    \"name\": \"nombre-de-usuario\",\n    \"email\": \"correo@ejemplo.com\",\n    \"password\": \"123456789\"\n  }\n  ```\n\n#### Inicio de Sesión\n\n- **URL**: `sign-in/signIn`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"email\": \"correo@ejemplo.com\",\n    \"password\": \"123456789\"\n  }\n  ```\n\n  #### Refrescar Token\n\n- **URL**: `token/refreshToken`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"refreshToken\": \"antiguo_token\"\n  }\n  ```\n\n  #### Observación\n\n  Para refrescar el token desde el frontend, asegúrate de incluir el encabezado x-refresh-token con el valor del token de actualización (refresh token) en tu solicitud HTTP.\n\n  ```json\n  {\n    \"x-refresh-token\": \"refreshToken\"\n  }\n  ```\n\n#### Enviar token por correo electrónico\n\n- **URL**: `reset-password/sendPasswordReset`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"email\": \"correo@ejemplo.com\"\n  }\n  ```\n\n#### Actualizar contraseña\n\n- **URL**: `user/recoverPassword/:id`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"password\": \"contraseña-nueva\"\n  }\n  ```\n\n#### Validación con Google\n\n- **URL**: `with-provider/google`\n- **Método**: `GET`\n- **Cuerpo**: No aplica\n\n- **URL**: `with-provider/google/callback`\n- **Método**: `GET`\n- **Cuerpo**: No aplica\n\n#### Validación con Github\n\n- **URL**: `with-provider/github`\n- **Método**: `GET`\n- **Cuerpo**: No aplica\n\n- **URL**: `with-provider/github/callback`\n- **Método**: `GET`\n- **Cuerpo**: No aplica\n\n### Roles\n\nLos roles pueden ser asignados a los usuarios y utilizados para proteger rutas específicas. Además podras asignar permisos a roles especificos. Ejemplo de roles: `admin`, `member`.\n\n```typescript\n@Auth()\n@Post('recoverPassword/:id')\nasync recoverPassword(@Param('id') id: number, @Body() updatePassword: UpdatePasswordDto) {\n    return this.userService.recoverPassword(id, updatePassword);\n  }\n```\n\nEn ese ejemplo, se importa el decorador `@Auth()` que se encargara de validar si la persona tiene asigando un rol y si ese rol tiene permiso para acceder a esa ruta.\n\n#### Registrar nuevo Rol\n\n- **URL**: `roles/newRol`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"name\": \"deve\"\n  }\n  ```\n\n#### Registrar nuevo Permiso\n\n- **URL**: `permissions/newPermission`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"route\": \"/user/profile/:id\"\n  }\n  ```\n\n#### Asignar permiso a Rol\n\n- **URL**: `rp/newrp`\n- **Método**: `POST`\n- **Cuerpo**:\n\n  ```json\n  {\n    \"id_rol\": 1,\n    \"id_permissions\": 1\n  }\n  ```\n\n## Desarrollo\n\n### Ejecución de la Aplicación en Desarrollo\n\n```bash\nnpm run build-and-start\n```\n\n### Compilación y Ejecución en Producción\n\n```bash\nnpm run build\nnpm run start:prod\n```\n\n## Diagrama de Flujo\n\n\u003cimg src=\"https://imgur.com/CoElyl2.jpg\"\u003e\n\n## Diagrama ER\n\u003cimg src=\"https://imgur.com/Gg7vLFG.jpg\"\u003e\n\n## Contribución\n\n1. Haz un fork del repositorio.\n\n2. Crea una nueva rama:\n\n```bash\ngit checkout -b feature/nueva-caracteristica\n```\n\n3. Realiza tus cambios y haz commit:\n\n```bash\ngit commit -am 'Añadir nueva característica'\n```\n\n4. Empuja tus cambios a la rama:\n\n```bash\ngit push origin feature/nueva-caracteristica\n```\n\n5. Abre un Pull Request en GitHub, describiendo los cambios propuestos.\n\n## Lincencia\n\nEste proyecto está licenciado bajo la Licencia MIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanjocodedev%2Fauth-nest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuanjocodedev%2Fauth-nest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanjocodedev%2Fauth-nest/lists"}