{"id":15715231,"url":"https://github.com/crazyoptimist/nest-starter","last_synced_at":"2025-05-12T21:13:00.244Z","repository":{"id":41048809,"uuid":"360806446","full_name":"crazyoptimist/nest-starter","owner":"crazyoptimist","description":"NestJS RESTful API starter for minimalists","archived":false,"fork":false,"pushed_at":"2024-09-03T16:14:36.000Z","size":786,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-12T21:12:40.555Z","etag":null,"topics":["boilerplate","nestjs","openapi3","rest-api","starter-kit","template","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","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/crazyoptimist.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-04-23T07:53:38.000Z","updated_at":"2024-12-26T17:54:09.000Z","dependencies_parsed_at":"2023-02-09T13:01:14.745Z","dependency_job_id":"0c789913-1aae-4854-b2e1-a275f55bc27b","html_url":"https://github.com/crazyoptimist/nest-starter","commit_stats":null,"previous_names":[],"tags_count":17,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fnest-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fnest-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fnest-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyoptimist%2Fnest-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazyoptimist","download_url":"https://codeload.github.com/crazyoptimist/nest-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253823462,"owners_count":21969848,"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":["boilerplate","nestjs","openapi3","rest-api","starter-kit","template","typeorm","typescript"],"created_at":"2024-10-03T21:40:41.919Z","updated_at":"2025-05-12T21:13:00.220Z","avatar_url":"https://github.com/crazyoptimist.png","language":"TypeScript","readme":"# NestJS Starter\n\n[![build \u0026 test](https://github.com/crazyoptimist/nest-starter/actions/workflows/build.yml/badge.svg)](https://github.com/crazyoptimist/nest-starter/actions/workflows/build.yml)\n\nBuild a modular REST API with NestJS framework.\n\n## Table of Contents\n\n- [What Is This?](#what-is-this)\n- [Getting Started](#getting-started)\n- [Database Migrations](#database-migrations)\n  - [Generate a New Migration](#generate-a-new-migration)\n  - [Run Pending Migrations](#run-pending-migrations)\n  - [Revert Migrations](#revert-migrations)\n- [Tests](#tests)\n- [Environment Configuration](#environment-configuration)\n- [API Documentation](#api-documentation)\n- [Authentication](#authentication)\n- [License](#license)\n- [Maintainers](#maintainers)\n\n## What Is This?\n\nThis is a NestJS RESTful API starter that includes JWT authentication, OpenAPI 3 documentation, and TypeORM integration.\n\nThe reason I maintain it is because using this template allows you to quickly set up a production-ready RESTful API with minimal boilerplate code.\n\n## Getting Started\n\nCreate a dotenv file and fill it out with the appropriate values.\n\n```bash\ncp .env.example .env\n```\n\nInstall dependencies\n\n```bash\nnpm install\n```\n\nRun the application\n\n```bash\nnpm run dev\n```\n\nHMR(Hot Module Reload) is configured with webpack.\n\n## Database Migrations\n\nIf you don't require incremental database migrations, set the DB_SYNC environment variable to true. This will continuously synchronize the database structure with the schema defined in the codebase.\n\n__However, DO NOT set DB_SYNC to true in a production environment, as doing so may result in data loss!__\n\n#### Generate a New Migration\n\nMake sure to use npm for the following commands, as yarn does not support `$npm_config_name`.\n\n```bash\nnpm run migration:generate --name=AddAgeColumnToUser\n```\n\nMigration files are located in the `src/migrations` directory.\n\n#### Run Pending Migrations\n\n```bash\nnpm run migration:run\n```\n\nUsing Docker:\n\n```bash\ndocker exec nest npm run migration:run\n```\n\n#### Revert Migrations\n\nRevert the last migration\n\n```bash\nnpm run migration:revert\n```\n\n## Tests\n\n```bash\n# unit tests\nnpm run test\n\n# e2e tests\nnpm run test:e2e\n\n# test coverage\nnpm run test:cov\n```\n\n## Environment Configuration\n\n`@nestjs/config` has been used, so you can just inject `ConfigService` to read environment variables from the dotenv file.\n\n## API Documentation\n\nOpenAPI 3.0 has been configured, and the API documentation is hosted at `BASE_URL/api/docs`.\n\n## Authentication\n\nJWT authentication has been configured.\n\n## License\n\nMIT\n\n## Maintainers\n\n[crazyoptimist](https://crazyoptimist.net)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyoptimist%2Fnest-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazyoptimist%2Fnest-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyoptimist%2Fnest-starter/lists"}