{"id":15142587,"url":"https://github.com/jorkdev/hexagonal_cqrs_backend","last_synced_at":"2026-01-21T16:02:26.291Z","repository":{"id":257511389,"uuid":"858494366","full_name":"JorkDev/hexagonal_cqrs_backend","owner":"JorkDev","description":"Este proyecto es una implementación de un backend basado en la arquitectura hexagonal y utilizando el patrón de CQRS (Command Query Responsibility Segregation). La aplicación permite la gestión de usuarios, incluyendo funcionalidades de registro y consulta de información de usuario.","archived":false,"fork":false,"pushed_at":"2024-09-17T04:55:41.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T21:49:11.726Z","etag":null,"topics":["docker","fastapi","mysql","python"],"latest_commit_sha":null,"homepage":"","language":"Python","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/JorkDev.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-09-17T01:58:35.000Z","updated_at":"2024-09-17T04:52:57.000Z","dependencies_parsed_at":"2024-09-17T05:57:31.068Z","dependency_job_id":null,"html_url":"https://github.com/JorkDev/hexagonal_cqrs_backend","commit_stats":null,"previous_names":["jorkdev/hexagonal_cqrs_backend"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorkDev%2Fhexagonal_cqrs_backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorkDev%2Fhexagonal_cqrs_backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorkDev%2Fhexagonal_cqrs_backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JorkDev%2Fhexagonal_cqrs_backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JorkDev","download_url":"https://codeload.github.com/JorkDev/hexagonal_cqrs_backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247509165,"owners_count":20950233,"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":["docker","fastapi","mysql","python"],"created_at":"2024-09-26T09:42:55.764Z","updated_at":"2026-01-21T16:02:23.442Z","avatar_url":"https://github.com/JorkDev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Hexagonal CQRS Backend\n\n## Descripción\n\nEste proyecto tiene como objetivo la creación de un backend con una arquitectura basada en Hexagonal Architecture (Arquitectura Hexagonal) y el patrón CQRS (Command Query Responsibility Segregation). El objetivo es organizar el código de manera limpia y estructurada, separando las responsabilidades de comandos y consultas, así como la capa de dominio, infraestructura y aplicación.\n\n## Tecnologías usadas:\n\n- **FastAPI** - Framework de Python para el desarrollo de APIs rápidas y sencillas.\n- **SQLAlchemy** - ORM (Object-Relational Mapper) para manejar interacciones con la base de datos.\n- **MySQL** - Base de datos relacional utilizada para almacenar los datos.\n- **Docker** - Para contenedores y despliegue.\n- **Pydantic** - Para validaciones y estructuración de datos.\n- **Uvicorn** - Servidor ASGI para la ejecución del backend.\n\n## Requisitos previos:\n\n- **Python 3.8+**\n- **MySQL** instalado y configurado en tu máquina.\n\n## Instrucciones de Configuración\n\n### Opción 1: Usando Docker\n\n1. Clona el repositorio del proyecto:\n   ```bash\n   git clone https://github.com/JorkDev/hexagonal_cqrs_backend\n   cd hexagonal_cqrs_backend\n   ```\n\n2. Ejecuta el proyecto usando Docker Compose:\n   ```bash\n   docker-compose up --build\n   ```\n\n3. La aplicación estará disponible en `http://localhost:8000`.\n\n### Opción 2: Configuración manual\n\n1. Clona el repositorio del proyecto:\n   ```bash\n   git clone https://github.com/JorkDev/hexagonal_cqrs_backend\n   cd hexagonal_cqrs_backend\n   ```\n\n2. Crea y activa un entorno virtual (opcional pero recomendado):\n   ```bash\n   python3 -m venv venv\n   source venv/bin/activate  # En Windows: venv\\Scripts\u0007ctivate\n   ```\n\n### Instalación de dependencias:\n\nPrimero, es necesario crear un entorno virtual en Python para aislar las dependencias del proyecto. Si no tienes `virtualenv` instalado, puedes instalarlo con:\n\n```bash\npip install virtualenv\n```\n\nLuego, sigue los siguientes pasos:\n\n```bash\n# Crear entorno virtual\npython -m venv venv\n\n# Activar entorno virtual (Linux/Mac)\nsource venv/bin/activate\n\n# Activar entorno virtual (Windows)\n.\u000benv\\Scripts\u0007ctivate\n\n# Instalar las dependencias del proyecto\npip install -r requirements.txt\n```\n\n## Configuración de la Base de Datos:\n\n1. Asegúrate de tener **MySQL** instalado en tu máquina.\n2. Crea una base de datos llamada `hexagonal_cqrs_backend` con un usuario que tenga permisos de escritura y lectura.\n\n```sql\nCREATE DATABASE hexagonal_cqrs_backend;\nCREATE USER 'new_user'@'localhost' IDENTIFIED BY 'new_password';\nGRANT ALL PRIVILEGES ON hexagonal_cqrs_backend.* TO 'new_user'@'localhost';\nFLUSH PRIVILEGES;\n```\n\n3. Verifica que la conexión a la base de datos en `main.py` esté correctamente configurada con los credenciales de MySQL:\n\n```python\nSQLALCHEMY_DATABASE_URL = \"mysql+pymysql://new_user:new_password@localhost/hexagonal_cqrs_backend\"\n```\n\n## Cómo correr el proyecto:\n\n### Opción 1: Localmente\n\n1. Asegúrate de tener activado tu entorno virtual y que las dependencias estén instaladas.\n2. Inicia la aplicación con **Uvicorn**:\n\n```bash\nuvicorn main:app --reload\n```\n\nEsto levantará el servidor en `http://127.0.0.1:8000/`.\n\n### Opción 2: Usando Docker\n\nSi prefieres usar Docker para correr el proyecto, puedes usar el siguiente `Dockerfile` incluido en el proyecto.\n\nPara construir la imagen de Docker:\n\n```bash\ndocker build -t hexagonal_cqrs_backend .\n```\n\nPara correr el contenedor:\n\n```bash\ndocker run -p 8000:8000 hexagonal_cqrs_backend\n```\n\n## Rutas implementadas\n\n1. **POST /register/**  \n   Registro de un nuevo usuario.  \n   Parámetros:  \n   - `username` (str)\n   - `email` (str)\n\n   Ejemplo de solicitud:\n\n   ```bash\n   curl -X POST \"http://127.0.0.1:8000/register/\" -H \"Content-Type: application/json\" -d '{\"username\": \"testuser\", \"email\": \"testuser@example.com\"}'\n   ```\n\n2. **GET /user/{user_id}**  \n   Obtener un usuario por su ID.\n\n3. **GET /**  \n   Página de bienvenida para verificar que el backend está funcionando.\n\n## Cómo ejecutar los tests:\n\nSe han implementado algunos tests básicos para validar las funcionalidades del backend. Para ejecutarlos, simplemente corre:\n\n```bash\npytest\n```\n\nEsto ejecutará todos los tests dentro de la carpeta `tests/` y te mostrará los resultados.\n\n## Conclusiones:\n\nEl proyecto ha sido desarrollado para demostrar los principios de la arquitectura hexagonal y CQRS. El uso de FastAPI y SQLAlchemy permite una implementación modular y escalable que facilita la separación de responsabilidades y la mantenibilidad del código. Este proyecto puede ser extendido para manejar más casos de uso como la autenticación, autorización, y otras operaciones de dominio complejas.\n\nAgradecemos tu tiempo y estamos abiertos a cualquier consulta técnica adicional a través del contacto proporcionado.\n\n![Vista Previa](https://i.imgur.com/kcMev97.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorkdev%2Fhexagonal_cqrs_backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjorkdev%2Fhexagonal_cqrs_backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorkdev%2Fhexagonal_cqrs_backend/lists"}