{"id":47830299,"url":"https://github.com/seaguntech/seaguntech-node-api-template","last_synced_at":"2026-04-03T20:10:30.449Z","repository":{"id":343647583,"uuid":"1178506748","full_name":"seaguntech/seaguntech-node-api-template","owner":"seaguntech","description":"☁️ NestJS REST API template with TypeScript, Prisma, Redis auth, OpenAPI/Swagger, and Vitest testing. Production-ready with CI/CD, Docker, and modular architecture.","archived":false,"fork":false,"pushed_at":"2026-03-11T10:29:34.000Z","size":140,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-11T13:05:51.169Z","etag":null,"topics":["clean-architecture","docker","nestjs","nodejs","openapi","prisma","redis","swagger-ui","template"],"latest_commit_sha":null,"homepage":"https://seaguntech-node-api-template-production.up.railway.app/api/docs","language":"TypeScript","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/seaguntech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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":"2026-03-11T04:53:01.000Z","updated_at":"2026-03-11T10:29:36.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/seaguntech/seaguntech-node-api-template","commit_stats":null,"previous_names":["seaguntech/seaguntech-node-api-template"],"tags_count":null,"template":true,"template_full_name":null,"purl":"pkg:github/seaguntech/seaguntech-node-api-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seaguntech%2Fseaguntech-node-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seaguntech%2Fseaguntech-node-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seaguntech%2Fseaguntech-node-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seaguntech%2Fseaguntech-node-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seaguntech","download_url":"https://codeload.github.com/seaguntech/seaguntech-node-api-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seaguntech%2Fseaguntech-node-api-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31374208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T17:53:18.093Z","status":"ssl_error","status_checked_at":"2026-04-03T17:53:17.617Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["clean-architecture","docker","nestjs","nodejs","openapi","prisma","redis","swagger-ui","template"],"created_at":"2026-04-03T20:10:28.642Z","updated_at":"2026-04-03T20:10:30.437Z","avatar_url":"https://github.com/seaguntech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg width=\"2048\" height=\"256\" alt=\"template-node-nesst\" src=\"https://github.com/user-attachments/assets/391ff907-a5d8-4d21-86d3-b46fc76d7dda\" /\u003e\n\n# SeagunTech Node API Template\n\nNestJS-based REST API template with OpenAPI, Prisma-ready architecture, Redis-ready auth session design, and Vitest test baseline.\n\n## Tech Baseline\n\n- NestJS\n- REST + OpenAPI\n- class-validator + class-transformer\n- Vitest (unit and e2e)\n\n## Quick Start\n\n1. Install dependencies:\n\n```bash\npnpm install\n```\n\n2. Create environment file:\n\n```bash\ncp .env.example .env\n```\n\n3. Start local infrastructure (PostgreSQL + Redis):\n\n```bash\ndocker compose up -d\n```\n\n4. Generate Prisma client:\n\n```bash\npnpm run prisma:generate\n```\n\n5. Start app:\n\n```bash\npnpm run start:dev\n```\n\n## Endpoints\n\n- Liveness: `GET /api/v1/health/live`\n- Readiness: `GET /api/v1/health/ready`\n- System info: `GET /api/v1/system/info`\n- Auth register: `POST /api/v1/auth/register`\n- Auth login: `POST /api/v1/auth/login`\n- Auth refresh: `POST /api/v1/auth/refresh`\n- Auth logout: `POST /api/v1/auth/logout`\n- Auth profile: `GET /api/v1/auth/profile`\n- Users create: `POST /api/v1/users`\n- Users list (pagination): `GET /api/v1/users?page=1\u0026limit=20`\n- Users detail: `GET /api/v1/users/:userId`\n- Users update: `PATCH /api/v1/users/:userId`\n- Users delete: `DELETE /api/v1/users/:userId`\n- Swagger: `GET /api/v1/docs`\n\n## Swagger Basic Auth (optional)\n\n- Set `DOCS_BASIC_AUTH_ENABLED=true` to protect `/api/docs` with basic auth.\n- Set `DOCS_USERNAME` and `DOCS_PASSWORD` when enabling it.\n\n## Test Commands\n\n- Unit: `pnpm run test:unit`\n- Integration: `pnpm run test:int`\n- E2E: `pnpm run test:e2e`\n- Unit coverage: `pnpm run test:cov:unit`\n- All: `pnpm run test`\n\n## CI Workflows\n\n- Lint + typecheck: `.github/workflows/lint-typecheck.yml`\n- Unit tests + coverage: `.github/workflows/unit-test.yml`\n- Integration + e2e: `.github/workflows/integration-e2e.yml`\n- Build: `.github/workflows/build.yml`\n\n## Delivery Process\n\n- PR template: `.github/pull_request_template.md`\n- Release checklist: `docs/10-RELEASE-CHECKLIST.md`\n- Branch protection guide: `docs/06-DEVOPS-CICD.md`\n\n## Prisma Commands\n\n- Generate client: `pnpm run prisma:generate`\n- Run migration locally: `pnpm run prisma:migrate:dev`\n- Deploy migration: `pnpm run prisma:migrate:deploy`\n- Open Prisma Studio: `pnpm run prisma:studio`\n\n## OpenAPI Client Generation\n\n- Export OpenAPI spec: `pnpm run openapi:export`\n- Clean generated client: `pnpm run gen:client:clean`\n- Generate TypeScript client: `pnpm run gen:client`\n- Verify spec/client synced (CI-friendly): `pnpm run openapi:check`\n- Generator config: `openapi-config.yaml`\n- Exported spec: `openapi/openapi.json`\n- Generated SDK output: `generated/openapi-client`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseaguntech%2Fseaguntech-node-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseaguntech%2Fseaguntech-node-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseaguntech%2Fseaguntech-node-api-template/lists"}