{"id":24200076,"url":"https://github.com/organization-devxp/crud-users-nodejs-express-mysql","last_synced_at":"2025-03-03T09:25:26.024Z","repository":{"id":270743912,"uuid":"911033207","full_name":"Organization-DevXP/CRUD-Users-Nodejs-Express-MySQL","owner":"Organization-DevXP","description":"Este proyecto es una plantilla inicial para desarrollar APIs en Node.js. Incluye características como autenticación, cifrado de contraseñas, documentación con Swagger, y conexión a bases de datos.","archived":false,"fork":false,"pushed_at":"2025-01-25T03:48:25.000Z","size":54,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-25T04:23:22.819Z","etag":null,"topics":["bcryptjs","express","express-validator","jwt-authentication","morgan-middleware","mysql-database","nodejs","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Organization-DevXP.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-02T05:05:25.000Z","updated_at":"2025-01-25T03:48:29.000Z","dependencies_parsed_at":"2025-01-03T21:00:19.217Z","dependency_job_id":null,"html_url":"https://github.com/Organization-DevXP/CRUD-Users-Nodejs-Express-MySQL","commit_stats":null,"previous_names":["organization-devxp/crud-users-nodejs-express-mysql"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Organization-DevXP%2FCRUD-Users-Nodejs-Express-MySQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Organization-DevXP%2FCRUD-Users-Nodejs-Express-MySQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Organization-DevXP%2FCRUD-Users-Nodejs-Express-MySQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Organization-DevXP%2FCRUD-Users-Nodejs-Express-MySQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Organization-DevXP","download_url":"https://codeload.github.com/Organization-DevXP/CRUD-Users-Nodejs-Express-MySQL/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241638825,"owners_count":19995272,"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":["bcryptjs","express","express-validator","jwt-authentication","morgan-middleware","mysql-database","nodejs","swagger"],"created_at":"2025-01-13T20:40:56.274Z","updated_at":"2025-03-03T09:25:26.018Z","avatar_url":"https://github.com/Organization-DevXP.png","language":"JavaScript","readme":"# Node.js API Template\n\nEste proyecto es una plantilla inicial para desarrollar APIs en Node.js. Incluye características como autenticación, cifrado de contraseñas, documentación con Swagger, y conexión a bases de datos.\n\n## Características principales\n\n- **Autenticación con JWT:** Generación y validación de tokens de acceso.\n- **Cifrado de contraseñas:** Uso de bcrypt.js para almacenar contraseñas de forma segura.\n- **Documentación interactiva:** Configuración de Swagger para una exploración sencilla de los endpoints.\n- **Gestión de errores:** Manejo centralizado de errores para garantizar respuestas consistentes.\n- **Registro de solicitudes:** Uso de Morgan para registrar solicitudes HTTP.\n- **Estructura modular:** Organización clara de rutas, controladores, y utilidades.\n- **Gestión de usuarios:** Inclusión de rutas para registro, inicio de sesión, cierre de sesión, y administración de usuarios (crear, actualizar, eliminar, restaurar).\n\n## Tecnologías utilizadas\n\n- [Node.js](https://nodejs.org/)\n- [Express](https://expressjs.com/)\n- [JWT (jsonwebtoken)](https://github.com/auth0/node-jsonwebtoken)\n- [bcrypt.js](https://github.com/dcodeIO/bcrypt.js/)\n- [Swagger](https://swagger.io/)\n- [Morgan](https://github.com/expressjs/morgan)\n- [MySQL](https://www.mysql.com/)\n\n## Instalación\n\n### Requisitos previos\n\n- Node.js (v14 o superior)\n- npm o yarn\n\n### Pasos\n\n1. Clona este repositorio:\n\n   ```bash\n   git clone \u003cURL_DEL_REPOSITORIO\u003e\n   cd \u003cNOMBRE_DEL_PROYECTO\u003e\n   ```\n\n2. Instala las dependencias:\n\n   ```bash\n   npm install\n   # o con yarn\n   yarn install\n   ```\n\n3. Crea un archivo `.env` en la raíz del proyecto con el siguiente contenido:\n\n   ```env\n   DB_HOST=localhost\n   DB_USER=root\n   DB_PASSWORD=yourpassword\n   DB_NAME=namedatabase\n   JWT_SECRET=your_jwt_secret_key\n   ```\n\n4. Inicia la aplicación:\n   ```bash\n   npm start\n   ```\n\n## Endpoints principales\n\nLa documentación completa de los endpoints está disponible en Swagger. Una vez que el servidor esté corriendo, accede a:\n\n```\nhttp://localhost:3000/api-docs\n```\n\n### Explicación de las rutas disponibles:\n\n- POST /api/v1/users/register: Esta ruta es para registrar\n  un nuevo usuario. Ya tienes la validación y los errores\n  manejados a través de los middlewares validateRegisterUser\n  y handleValidationErrors.\n- POST /api/v1/users/login: Ruta para la autenticación de\n  usuario. También con la validación y manejo de errores.\n- POST /api/v1/users/logout: Ruta para cerrar sesión del\n  usuario. Esta acción solo devuelve un mensaje de éxito.\n- GET /api/v1/users: Ruta para listar todos los usuarios.\n  Está protegida por un middleware de autenticación\n  (authenticateToken) y también verifica si el usuario es\n  administrador a través de verifyAdmin.\n- GET /api/v1/users/:id: Ruta para obtener los datos de un\n  usuario por su ID. Requiere autenticación.\n- PUT /api/v1/users/update/:id: Ruta para actualizar la\n  información de un usuario. Requiere validación, manejo de\n  errores y autenticación.\n- DELETE /api/v1/users/delete/:id: Ruta para eliminar a un\n  usuario. Está protegida por autenticación.\n- PUT /api/v1/users/restore/:id: Ruta para restaurar a un\n  usuario eliminado. Solo los administradores pueden acceder\n  a esta ruta.\n\n## Scripts\n\n- `npm start`: Inicia la aplicación en modo producción.\n- `npm run dev`: Inicia la aplicación en modo desarrollo.\n\n## Estructura del proyecto\n\n```bash\n├── src/\n│   ├── config/\n│   │   ├── tableUser.sql\n│   │   └── connectMySQL.js\n│   ├── controllers/\n│   │   ├── authController.js\n│   │   └── userController.js\n│   ├── models/\n│   │   └── MySQL/\n|   │       └── userModel.js\n│   ├── routes/\n│   │   ├── authRoutes.js\n│   │   └── userRoutes.js\n│   ├── services/\n│   │   ├── authService.js\n│   │   └── userService.js\n│   ├── utils/\n│   │   ├── bcrypt.js\n│   │   └── jwt.js\n│   │\n│   ├── middleware/\n│   │   ├── validataion\n│   │   │   ├── fieldsValidation.js\n│   │   │   ├── validateUpdateUser.js\n│   │   │   └── userValidation.js\n│   │   ├── handleValidationErrors.js\n│   │   ├── checkUserActiveMiddleware.js\n│   │   ├── verifyAdmin.js\n│   │   └── authMiddleware.js\n│   │\n│   ├── app.js    # Configuración de la app\n│   └── server.js # Arranque del servidor\n├── swagger/      # Configuracion de Swagger\n├── .env.example  # Ejemplo de Variables de entorno\n├── package.json  # Dependencias y scripts\n└──\n```\n\n## Contribución\n\nPor favor, consulta el archivo [CONTRIBUTING.md](./CONTRIBUTING.md) para obtener las pautas detalladas sobre cómo contribuir a este proyecto.\n\n## Licencia\n\nEste proyecto está bajo la Licencia MIT. Consulta el archivo `LICENSE` para más detalles.\n\n## Redes Sociales de OrganizationDevXp\n\nPuedes seguirnos o unirte a nuestras comunidades en las siguientes plataformas:\n\n [![Linkedin](https://img.shields.io/badge/LinkedIn-0A66C2?style=social\u0026logo=linkedin)](https://www.linkedin.com/company/organization-devxp)\n [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=social\u0026logo=youtube)](https://www.youtube.com/@Organization-DevXP)\n [![WhatsApp](https://img.shields.io/badge/WhatsApp-25D366?style=social\u0026logo=whatsapp)](https://chat.whatsapp.com/FfX0fXV4xHzCvFoVFn7ssa)\n [![Discord](https://img.shields.io/badge/Discord-7289DA?style=social\u0026logo=discord)](https://discord.com/invite/j3hnJjR8Yd)\n [![GitHub](https://img.shields.io/badge/GitHub-181717?style=social\u0026logo=github)](https://github.com/Organization-DevXP)\n\n\n---\n\n¡Gracias por contribuir! Si tienes alguna duda o sugerencia, no dudes en abrir un issue o contactarnos.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forganization-devxp%2Fcrud-users-nodejs-express-mysql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forganization-devxp%2Fcrud-users-nodejs-express-mysql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forganization-devxp%2Fcrud-users-nodejs-express-mysql/lists"}