{"id":13807730,"url":"https://github.com/mugifly/angular-nest","last_synced_at":"2025-04-12T20:01:33.336Z","repository":{"id":41242601,"uuid":"481177451","full_name":"mugifly/angular-nest","owner":"mugifly","description":"Simple web app template with Angular v19 + NestJS v10 + ng-openapi-gen / Deployable on Heroku, Render.com, Google App Engine, Cloud Run and others (incl. Docker) / CI with GitHub Actions / Public Domain","archived":false,"fork":false,"pushed_at":"2025-03-11T18:07:45.000Z","size":2132,"stargazers_count":18,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T20:00:00.714Z","etag":null,"topics":["angular","docker","example","google-app-engine","google-cloud-run","heroku","nestjs","npm-workspaces","openapi","template"],"latest_commit_sha":null,"homepage":"https://angular-nest.onrender.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mugifly.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}},"created_at":"2022-04-13T10:50:56.000Z","updated_at":"2025-03-28T17:55:59.000Z","dependencies_parsed_at":"2024-04-16T00:31:42.752Z","dependency_job_id":"dda0c580-8614-4c39-8566-288862cfff97","html_url":"https://github.com/mugifly/angular-nest","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugifly%2Fangular-nest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugifly%2Fangular-nest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugifly%2Fangular-nest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mugifly%2Fangular-nest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mugifly","download_url":"https://codeload.github.com/mugifly/angular-nest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625499,"owners_count":21135513,"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":["angular","docker","example","google-app-engine","google-cloud-run","heroku","nestjs","npm-workspaces","openapi","template"],"created_at":"2024-08-04T01:01:29.617Z","updated_at":"2025-04-12T20:01:33.314Z","avatar_url":"https://github.com/mugifly.png","language":"TypeScript","readme":"# angular-nest\n\nSimple web app template with Angular + NestJS + ng-openapi-gen + Angular Material.\n\nDeployable on Heroku, Render, Google App Engine (GAE), Cloud Run and other hosting services using with/without Docker ([learn more](https://github.com/mugifly/angular-nest/wiki/#Deployments)).\n\n[![Build](https://github.com/mugifly/angular-nest/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/mugifly/angular-nest/actions/workflows/build.yml)\n\n---\n\n## Key Elements\n\nThere is some variations... https://github.com/mugifly/angular-nest/wiki#variations\n\n- Angular -- for Frontend app.\n- NestJS -- for Backend app.\n- ng-openapi-gen -- for API Client generation.\n- Angular Material -- for UI.\n  - NOTE: There is also a [vanilla branch](https://github.com/mugifly/angular-nest/tree/vanilla) that doesn't include Angular Material.\n- Docker -- for Production environment.\n  - NOTE: Deployments without Docker are also supported.\n- Karma + Jasmine -- for Unit testing of Frontend (with Puppeteer + Headless Chromium)\n- Jest -- for Unit testing of Backend\n- GitHub Actions -- for CI\n- npm Workspaces - for Monorepo structure.\n\n---\n\n## Quick Start for Development\n\n### StackBlitz\n\nStackBlitz lets you quickly run and edit your source code in your browser.\n\n[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/mugifly/angular-nest/tree/master?file=client%2Fsrc%2Fapp%2Fapp.component.html)\n\n### Local\n\nBefore you start, you should install the following softwares:\n\n- Git\n\n- Node.js v22+\n\n- Visual Studio Code\n\nNext, please [Create a new repository from this repository](https://github.com/mugifly/angular-nest/generate).\n\nThen, execute as the following in your terminal:\n\n```\n$ git clone git@github.com:YOUR_GITHUB_NAME/angular-nest.git\n$ cd angular-nest/\n\n$ npm install\n\n$ npm run start:dev\n```\n\nFinally, open the web browser and navigate to `http://localhost:4200/`.\nAlso, when you edit the frontend source-code, auto-reloading applies your changes to the browser immediately.\n\nAn API documentation is generated by Swagger UI, and you can access it at `http://localhost:4200/api/docs`.\n\nSee the [Wiki](https://github.com/mugifly/angular-nest/wiki/) for additional information.\nYou'll find tips for implementing database connectivity, guides for future updates, and more.\n\n---\n\n## Quick Start for Deployment\n\nThis app supports direct deployment to [various hosting services](https://github.com/mugifly/angular-nest/wiki/#Deployments) as a production environment.\n\nIt's also very easy to automatic-deployment, because you don't have to run the build process locally or in CI.\n\n### Deployment on Heroku\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\nThis app can be deployed either to the `Heroku` stack (Node.js buildpack based) or the `Container` stack (Docker based).\n\nPlease see [Deploy to Heroku](https://github.com/mugifly/angular-nest/wiki/Deploy-to-Heroku) page for more informations.\n\n### Deployment on Render\n\n[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)\n\nThis app can be deployed either as a Node.js application or Docker based application.\n\nPlease see [Deploy to Render](https://github.com/mugifly/angular-nest/wiki/Deploy-to-Render) page for more informations.\n\n### Deployment on other servers (with/without Docker)\n\nhttps://github.com/mugifly/angular-nest/wiki/#Deployments\n\n---\n\n## CLI Commands\n\n### Start\n\n- Start the development server (watch mode): \u0026nbsp; `npm run dev`\n- Start the production app: \u0026nbsp; `npm run build \u0026\u0026 npm run start`\n\n### Angular CLI \u0026 Nest CLI\n\n- Angular CLI (@angular/cli): \u0026nbsp; `npm run ng`\n  - Generate component: \u0026nbsp; `npm run ng -- generate component foo-bar`\n  - Other `ng` commands can also be run by typing it after `npm run ng -- `. See [here](https://angular.io/cli#command-overview) for a list of the available commands.\n- Nest CLI (@nestjs/cli): \u0026nbsp; `npm run nest`\n  - Generate controller: \u0026nbsp; `npm run nest -- generate controller foo-bar`\n  - Other `nest` commands can also be run by typing it after `npm run nest -- `. See [here](https://docs.nestjs.com/cli/usages) for a list of the available commands.\n\n### Testing\n\n- Unit tests for frontend: \u0026nbsp; `npm run test -w client` \u0026nbsp; (Google Chrome and [dependencies of Puppeteer](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md) required)\n  - NOTE: If you have never generated an API client (or run `npm run dev`), you should run `npm run build-api-client` before running the test.\n- Unit tests for backend: \u0026nbsp; `npm run test -w server`\n- E2E tests for backend: \u0026nbsp; `npm run test:e2e -w server`\n\n### Install npm modules\n\n- Install for frontend: `npm install -w client XXXXX`\n- Install for backend: `npm install -w server XXXXX`\u003cbr\u003e(e.g. `npm install -w server @nestjs/typeorm typeorm`)\n\n---\n\n## License and Author\n\nThis project is released under the [CC0 1.0 Universal](https://github.com/mugifly/angular-nest/blob/master/LICENSE) license, by Masanori Ohgita ([mugifly](https://github.com/mugifly)).\n\nTherefore, a copyright notice is NOT required.\nFeel free to use or copy it to your project :)\n\nNOTE: However, some sample codes and documents (e.g. client/README.md and server/README.md) that generated by Angular CLI or Nest CLI may be based on their respective licenses.\n","funding_links":[],"categories":["Site Templates"],"sub_categories":["Free Templates"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmugifly%2Fangular-nest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmugifly%2Fangular-nest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmugifly%2Fangular-nest/lists"}