{"id":25515267,"url":"https://github.com/cristobalgvera/nestjs-template","last_synced_at":"2026-04-16T03:32:55.738Z","repository":{"id":278115471,"uuid":"934255680","full_name":"cristobalgvera/nestjs-template","owner":"cristobalgvera","description":"NestJS template to easily scaffold a project that is going to be deployed to AWS","archived":false,"fork":false,"pushed_at":"2025-02-25T01:43:49.000Z","size":122,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-28T12:44:45.477Z","etag":null,"topics":["aws","nestjs","serverless"],"latest_commit_sha":null,"homepage":"","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/cristobalgvera.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,"zenodo":null}},"created_at":"2025-02-17T14:28:54.000Z","updated_at":"2025-02-25T01:43:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"c8b77fda-3e08-4bd2-a994-c76e93794e87","html_url":"https://github.com/cristobalgvera/nestjs-template","commit_stats":null,"previous_names":["cristobalgvera/nestjs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/cristobalgvera/nestjs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristobalgvera%2Fnestjs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristobalgvera%2Fnestjs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristobalgvera%2Fnestjs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristobalgvera%2Fnestjs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cristobalgvera","download_url":"https://codeload.github.com/cristobalgvera/nestjs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cristobalgvera%2Fnestjs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31870508,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"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":["aws","nestjs","serverless"],"created_at":"2025-02-19T13:20:06.637Z","updated_at":"2026-04-16T03:32:55.730Z","avatar_url":"https://github.com/cristobalgvera.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NestJS Template\n\n\u003c!-- TODO: Complete this section with information about the project --\u003e\n\nThis template is a starting point for building a RESTful API with\nNestJS using AWS Lambda and API Gateway.\n\n## :exclamation: First time usage \u003c!-- TODO: Remove this section --\u003e\n\n1. Clone this template.\n\n   ```bash\n   # Clone the base branch\n   npx tiged --mode git git@github.com:cristobalgvera/nestjs-template.git \u003cYOUR_PROJECT_NAME\u003e\n   ```\n\n1. Look for all the `TODO:` comments or strings in the project and try to solve them.\n1. Create your initial commit.\n\n   ```bash\n   git add .\n   git commit -m \"chore: initial commit\"\n   ```\n\n## TL;DR\n\nChoose one of the following options to run the project:\n\n- Locally:\n\n  ```bash\n  # Install dependencies\n  pnpm install\n\n  # Run the app\n  pnpm start:dev\n\n  # If you want to debug the app\n  pnpm start:debug\n  ```\n\n  Then open the [Swagger UI](http://localhost:3000/api).\n\n- Serverless Offline:\n\n  ```bash\n  # Install dependencies\n  pnpm install\n\n  # Run the app\n  pnpm start:offline\n  ```\n\n  Then open the [Swagger UI](http://localhost:3000/local/api).\n\n- Docker container:\n\n  ```bash\n  # Start the app\n  docker compose up -d main\n  ```\n\n  Then open the [Swagger UI](http://localhost:3000/api).\n\n## Base project information\n\n## Technologies\n\nThis project is focused on give an easy-to-use alternative when creating an API,\nfollowing the latest standards of the industry and the company, with a mindset\nin simplify the initial process related to setup the base project.\n\nIt uses the following technologies:\n\n- [TypeScript](https://www.typescriptlang.org)\n- [NestJS](https://nestjs.com)\n- [Serverless](https://www.serverless.com)\n- [Docker](https://www.docker.com) _(easily launch locally)_\n- [ESLint](https://eslint.org)\n- [Prettier](https://prettier.io)\n- [Husky](https://typicode.github.io/husky)\n  - [Lint-staged](https://github.com/lint-staged/lint-staged)\n  - [Commitlint](https://commitlint.js.org)\n- [Jest](https://jestjs.io)\n\n### Code structure\n\nIn general, the project can be managed in the same way that a JavaScript\nproject can, feel free to structure the code as you want.\n\nWith this in mind, the project has examples of some types of implementations\nthat can be used. Those are located inside the branches starting with `example/`.\n\nThere are no better or worse alternatives, it just depends on the kind\nof project.\n\n## What to do next?\n\n- Create an account in AWS.\n  - Create a service account to deploy the application.\n    - Set the access key and secret in the repository secrets under the names:\n      - `AWS_ACCESS_KEY_ID`\n      - `AWS_SECRET_ACCESS_KEY`\n- Create an account in Serverless Framework.\n  - Generate an API key.\n  - Set the API key in the repository secrets\n    - `SERVERLESS_API_KEY`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcristobalgvera%2Fnestjs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcristobalgvera%2Fnestjs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcristobalgvera%2Fnestjs-template/lists"}