{"id":31651394,"url":"https://github.com/skyzerozx/api-hackaton-nestjs","last_synced_at":"2026-05-14T20:31:15.533Z","repository":{"id":153091327,"uuid":"559688321","full_name":"SkyZeroZx/API-Hackaton-NestJS","owner":"SkyZeroZx","description":"API Hackaton for  GentlemanProgramming","archived":false,"fork":false,"pushed_at":"2022-10-30T21:37:20.000Z","size":528,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-07T08:57:36.485Z","etag":null,"topics":["gentleman-programming","nestjs","typescript","web-authentication"],"latest_commit_sha":null,"homepage":"https://api-hackaton.skyzerozx.com","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/SkyZeroZx.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-30T21:37:17.000Z","updated_at":"2022-12-11T03:36:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"1cce7fe8-2929-4170-85df-b481c6a50c07","html_url":"https://github.com/SkyZeroZx/API-Hackaton-NestJS","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SkyZeroZx/API-Hackaton-NestJS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkyZeroZx%2FAPI-Hackaton-NestJS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkyZeroZx%2FAPI-Hackaton-NestJS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkyZeroZx%2FAPI-Hackaton-NestJS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkyZeroZx%2FAPI-Hackaton-NestJS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SkyZeroZx","download_url":"https://codeload.github.com/SkyZeroZx/API-Hackaton-NestJS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkyZeroZx%2FAPI-Hackaton-NestJS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33042076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"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":["gentleman-programming","nestjs","typescript","web-authentication"],"created_at":"2025-10-07T08:55:00.614Z","updated_at":"2026-05-14T20:31:15.528Z","avatar_url":"https://github.com/SkyZeroZx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo-small.svg\" width=\"200\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n \n  \u003cp align=\"center\"\u003eEs el API REST para la WebAPP/PWA Hackaton For Gentleman Programming integrado con Web Authentication para el inicio de sesion passworless.\n  \u003ca href=\"https://github.com/code-sys/hackaton-getonbrd-front-end\" target=\"_blank\"\u003e FrontEnd Hackaton\u003c/a\u003e\u003c/p\u003e\n\n## :ledger: Index\n\n- [Pre-Requisitos](#pre-requisitos-)\n- [Instalación](#instalación-)\n- [Desarrollo](#desarrollo-%EF%B8%8F)\n  - [Build](#build)\n- [Despligue](#despliegue-)\n- [Logger](#logger)\n- [Documentación](#documentacion)\n- [Construido](#construido-con-)\n\n## Comenzando 🚀\n\n_Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas._\n\n_Puede ver una demo en el enlace:_\n\n```\nhttps://api-hackaton.skyzerozx.com\n```\n\n## Pre-Requisitos 📋\n\n_Software requerido_\n\n```\nNodeJS \u003e= 14.X\nNPM \u003e= 8.X\nNestJS \u003e= 9.X\nMySQL \u003e=8.X\n```\n\n_Software opcional_\n\n```\nVisual Studio Code ( O el editor de su preferencia)\n```\n\n## Instalación 🔧\n\n_Para ejecutar un entorno de desarrollo_\n\n_Previamente ejecutar el comando en la terminal para descargar \"node_modules\" para el funcionamiento del proyecto_\n\n```\n npm install\n```\n\n_Previamente a ejecutar el servidor en desarrollo configurar el archivo .env con las credenciales del servidor correos y base de datos , ejecutar :_\n\n```\n npm run start:dev\n```\n\n_Dirigirse a la ruta http://localhost:3000/ donde tendra el API REST levantada_\n\n## Desarrollo ⚙️\n\n_Las siguientes instrucciones serviran para ejecutar en su entorno local la pruebas unitarias realizadas para el proyecto_\n\n### Build\n\n_Para generar el build de producción del proyecto ejecutar el siguiente comando:_\n\n```\n npm run build\n```\n\n## Despliegue 👨🏻‍💻\n\n_Para desplegar el proyecto mediante Docker se tiene los archivos `Dockerfile` y `docker-compose.prod.yaml`, los cuales tienen preconfigurado la imagen y dependencias necesarias para levantar el proyecto_\n\n_Para construir la imagen y ejecutarla tenemos el siguiente comando , el cual tambien tomara nuestras variable de entorno del archivo `env`_\n\n_Ejecutar el siguiente comando en la raiz del proyecto_\n\n```\n docker-compose -f docker-compose.prod.yaml --env-file .env up --build\n```\n\n![Docker 1](/docs/docker/docker-1.png)\n\n![Docker 2](/docs/docker/docker-2.png)\n\n_En caso de requerir volver a ejecutar el contenedor del proyecto previamente creado ejecutar el comando:_\n\n```\n docker-compose -f docker-compose.prod.yaml --env-file .env up\n```\n\n## Documentacion\n\n_Se realizo la documentación del API Rest usando Swagger el cual puede encontrar en la ruta http://localhost:3000/docs/ en la configuración por default_\n\n![Swagger 1](/docs/swagger/swagger-1.jpg)\n\n## Logger\n\n_Se integro winston para reemplazar el logger de NestJS para realizar seguimiento y conservacion de los logs segun sea requerido_\n\n_En el archivo `.env` se tienen los siguientes apartados configurados por default:_\n\n```\nAPP_NAME=API-HACKATON\nDATE_PATTERN=YYYY-MM-DD\nMAX_SIZE=20m\nMAX_DAYS=14d\n```\n\n_Por default la carpeta donde se guardan los logs es `LOG` , el formato configurado es JSON_\n\n## Construido con 🛠️\n\n_Las herramientas utilizadas son:_\n\n- [NestJS](https://nestjs.com/) - El framework para construir aplicaciones del lado del servidor eficientes, confiables y escalables.\n- [NPM](https://www.npmjs.com/) - Manejador de dependencias\n- [Docker](https://www.docker.com/) - Para el despliegue de aplicaciones basado en contenedores\n- [Visual Studio Code](https://code.visualstudio.com/) - Editor de Codigo\n- [Prettier](https://prettier.io/) - Formateador de Codigo\n- [WebAuthn](https://webauthn.guide/) - Estándar web del proyecto FIDO2 de la Alianza FIDO\n- [TabNine](https://www.tabnine.com/) - Autocompletador de Codigo\n- [Swagger](https://swagger.io/) - Automatización de Documentación\n- [Winston](https://github.com/winstonjs/winston) - Logger para NodeJS\n\n## Versionado 📌\n\nUsamos [GIT](https://git-scm.com/) para el versionado.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyzerozx%2Fapi-hackaton-nestjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyzerozx%2Fapi-hackaton-nestjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyzerozx%2Fapi-hackaton-nestjs/lists"}