{"id":17644984,"url":"https://github.com/actuallyconnor/nest-js-starter","last_synced_at":"2025-06-12T20:05:09.829Z","repository":{"id":243419592,"uuid":"469124446","full_name":"ActuallyConnor/nest-js-starter","owner":"ActuallyConnor","description":"A Nest.js template project","archived":false,"fork":false,"pushed_at":"2022-03-12T16:01:34.000Z","size":244,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T07:13:48.697Z","etag":null,"topics":[],"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/ActuallyConnor.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-12T15:37:40.000Z","updated_at":"2022-03-12T16:01:56.000Z","dependencies_parsed_at":"2024-06-08T19:24:52.079Z","dependency_job_id":"fdd88555-5fe1-43c8-a67c-57c4d8a8ae54","html_url":"https://github.com/ActuallyConnor/nest-js-starter","commit_stats":null,"previous_names":["actuallyconnor/nest-js-starter"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ActuallyConnor/nest-js-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActuallyConnor%2Fnest-js-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActuallyConnor%2Fnest-js-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActuallyConnor%2Fnest-js-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActuallyConnor%2Fnest-js-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ActuallyConnor","download_url":"https://codeload.github.com/ActuallyConnor/nest-js-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActuallyConnor%2Fnest-js-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259521512,"owners_count":22870448,"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":[],"created_at":"2024-10-23T10:44:12.724Z","updated_at":"2025-06-12T20:05:09.813Z","avatar_url":"https://github.com/ActuallyConnor.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://example.com/\" target=\"blank\"\u003e\u003cimg src=\"https://www.example.com/logo.svg\" width=\"320\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n  \u003cp align=\"center\"\u003eAn API for use by \u003ca href=\"https://www.example.com/\" target=\"_blank\"\u003eExample\u003c/a\u003e\u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n\n## Description\n\nAn API for for use by [Example](https://www.example.com/)\n\n## Documentation\n\n### API Docs\n\n[https://example.com/api-docs/index.html](https://example.com/api-docs/index.html)\n\n### App Docs\n\n[https://example.com/app-docs/index.htmlm](https://example.com/app-docs/index.html)\n\n### SDK Code Docs\n\n[https://example.com/sdk-docs/index.html](https://example.com/sdk-docs/index.html)\n\n## Commands\n\n### Installation\n\nThis project requires [Docker](https://docs.docker.com/get-docker/)\n\n### Running the app\n\n#### Development\n\n```bash\n# Install dependencies\n$ npm install\n\n# Build containers\n$ make dev-build\n$ make dev-up\n```\n\n_Note: this will run with `--watch` enabled, so it will automatically detect changes and auto-reload the environment_\n\n#### Production\n\n```bash\n$ npm run start:prod\n```\n\n### Test\n\n```bash\n# integration tests\n$ make dev-shell-node-worker\n\n# Once inside the container\n$ sh test.sh\n```\n\n### TypeORM\n\nSee [using the TypeORM CLI](https://github.com/typeorm/typeorm/blob/master/docs/using-cli.md)\n\n```bash\n# Create migration - name must be in PascalCase\nnpm run typeorm migration:create -- -n \u003cNameOfMigration\u003e\n\n# Run migrations\nnpm run typeorm migration:run\n\n# Create - entity name must be in camelCase and you must suffix the name with \".entity\"\nnpm run typeorm entity:create -- -n \u003centityName\u003e.entity\n```\n\n### Creating Nest files\n\n```bash\n# Create controller\nnest g controller controllers/\u003cControllerName\u003e\n\n# Create module\nnest g module modules/\u003cModuleName\u003e\n\n# Create service\nnest g service services/\u003cServiceName\u003e\n```\n\n## SDK\n\n[sdk-example](https://github.com/username/example/packages/1274697)\n\nFor any questions please reach out to [First Last](mailto:example@example.com)\n\n## Docker image\n\n[example Docker image](https://github.com/username/example/pkgs/container/example)\n\nFirst you need to log in into GitHub's Docker registry. This will require you to log in using a PAT (personal access\ntoken) that has `read:packages` permissions.\n\n```shell\n# Docker login\ndocker login ghcr.io -u \u003cGitHub username\u003e -p \u003cGitHub PAT\u003e\n```\n\nThen you can pull the image\n\n```shell\ndocker pull ghcr.io/username/example:latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factuallyconnor%2Fnest-js-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factuallyconnor%2Fnest-js-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factuallyconnor%2Fnest-js-starter/lists"}