{"id":15046301,"url":"https://github.com/kauppfbi/ngx-deploy-docker","last_synced_at":"2025-10-26T17:31:08.445Z","repository":{"id":35143402,"uuid":"211845558","full_name":"kauppfbi/ngx-deploy-docker","owner":"kauppfbi","description":"Deploy your Angular Application to a Docker registry directly from the Angular CLI! 🚀","archived":false,"fork":false,"pushed_at":"2023-07-18T21:30:28.000Z","size":491,"stargazers_count":15,"open_issues_count":8,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-31T21:51:39.392Z","etag":null,"topics":["angular","angular-cli","deploy","docker","ng-deploy","publish"],"latest_commit_sha":null,"homepage":null,"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/kauppfbi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-09-30T11:36:19.000Z","updated_at":"2023-10-19T07:53:09.000Z","dependencies_parsed_at":"2024-06-21T15:44:46.526Z","dependency_job_id":"5990e200-bead-4914-9077-722fb5641b2d","html_url":"https://github.com/kauppfbi/ngx-deploy-docker","commit_stats":{"total_commits":99,"total_committers":4,"mean_commits":24.75,"dds":0.2727272727272727,"last_synced_commit":"a53eb1a4e04d119eb3957d6666a481ba5a2c93b5"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauppfbi%2Fngx-deploy-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauppfbi%2Fngx-deploy-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauppfbi%2Fngx-deploy-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauppfbi%2Fngx-deploy-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kauppfbi","download_url":"https://codeload.github.com/kauppfbi/ngx-deploy-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238375164,"owners_count":19461561,"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","angular-cli","deploy","docker","ng-deploy","publish"],"created_at":"2024-09-24T20:52:58.046Z","updated_at":"2025-10-26T17:31:03.128Z","avatar_url":"https://github.com/kauppfbi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ngx-deploy-docker 🚀🐳\n\n**This Project is still work in progress.**\n\n![CI Pipeline](https://github.com/kauppfbi/ngx-deploy-docker/workflows/CI%20Pipeline/badge.svg)\n[![NPM version][npm-image]][npm-url]\n[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?color=blue\u0026style=flat-square)](http://opensource.org/licenses/MIT)\n\n**Dockerize your Angular application with ease and deploy your image right from the Angular CLI to a registry 🚀**\n\n**Table of contents:**\n\n1. [📖 Changelog](#changelog)\n2. [🚀 Quick Start (local development)](#quickstart-local)\n3. [🚀 Continuous Delivery](#continuous-delivery)\n4. [📦 Options](#options)\n   - [--base-href](#base-href)\n   - [--build-target](#build-target)\n   - [--no-build](#no-build)\n   - [--image-name](#image-name)\n   - [--account](#account)\n   - [--tag](#tag)\n5. [📁 Configuration File](#configuration-file)\n6. [🏁 Next milestones](#milestones)\n\n\u003chr\u003e\n\n## 📖 Changelog \u003ca name=\"changelog\"\u003e\u003c/a\u003e\n\nA detailed changelog is available [here](https://github.com/kauppfbi/ngx-deploy-docker/blob/master/CHANGELOG.md).\n\n## 🚀 Quick Start (local development) \u003ca name=\"quickstart-local\"\u003e\u003c/a\u003e\n\nThis quick start assumes that you are starting from scratch.\nIf you already have an existing Angular project, skip step 1.\n\n1. Install the latest version of the **`Angular CLI` (v13.0.0 or greater) globally**\n   and create a new Angular project. Make sure you have a suitable version of `nodeJs` installed.\n\n   ```sh\n   npm install -g @angular/cli\n   ng new your-angular-project --defaults\n   cd your-angular-project\n   ```\n\n2. Add `ngx-deploy-docker` to your project.\n\n   ```sh\n   ng add ngx-deploy-docker\n   ```\n\n3. Make sure, Docker works properly on your client and you are authenticated at the repository of your choice.\n\n   ```sh\n   docker login\n   ```\n\n4. Deploy your newly built image to the registry with all default settings.\n   Your project will be automatically built in production mode.\n\n   ```sh\n   ng deploy\n   ```\n\n   Which is the same as:\n\n   ```sh\n   ng deploy your-angular-project\n   ```\n\n## 🚀 Continuous Delivery \u003ca name=\"continuous-delivery\"\u003e\u003c/a\u003e\n\n...more to come\n\n## 📦 Options \u003ca name=\"options\"\u003e\u003c/a\u003e\n\n#### --base-href \u003ca name=\"base-href\"\u003e\u003c/a\u003e\n\n- **optional**\n- Default: `undefined` (string)\n- Example:\n  - `ng deploy` – The tag `\u003cbase href=\"/\"\u003e` remains unchanged in your `index.html`\n  - `ng deploy --base-href=/XXX/` – The tag `\u003cbase href=\"/XXX/\"\u003e` is added to your `index.html`\n\nSpecifies the base URL for the application being built.\nSame as `ng build --base-href=/XXX/`\n\n#### --build-target \u003ca name=\"build-target\"\u003e\u003c/a\u003e\n\n- **optional**\n- Example:\n  - `ng deploy` – Angular project is build in production mode\n  - `ng deploy --build-target=\u003capp\u003e:build:test` – Angular project is using the configuration `test` (this configuration must exist in the `angular.json` file)\n\nA named build target, as specified in the `configurations` section of `angular.json`.\nEach named target is accompanied by a configuration of option defaults for that target.\nSame as `ng run \u003capp\u003e`.\nThis command has no effect if the option `--no-build` option is active.\n\n#### --no-build \u003ca name=\"no-build\"\u003e\u003c/a\u003e\n\n- **optional**\n- Default: `false` (boolean)\n- Example:\n  - `ng deploy` – Angular project is build in production mode before the deployment\n  - `ng deploy --no-build` – Angular project is NOT build\n\nSkip build process during deployment.\nThis can be used when you are sure that you haven't changed anything and want to deploy with the latest artifact.\nThis command causes the `--build-target` setting to have no effect.\n\n#### --image-name \u003ca name=\"image-name\"\u003e\u003c/a\u003e\n\n- **optional**\n- Example:\n  - `ng deploy` – Docker Image is build with the name of the project as image name\n  - `ng deploy --image-name=your-special-name` – Docker Image is built with the name provided.\n\n#### --account \u003ca name=\"account\"\u003e\u003c/a\u003e\n\n- **optional**\n- Alias: `-a`\n- Default: `` (string)\n- Example:\n  - `ng deploy` – Docker Image name is **not** prefixed.\n  - `ng deploy --account=test` – Docker image name is prefixed with the provided account, like `account/image-name`.\n\n\u003e This option may be necessary, depending on your write-rights within the repository, you want to push to.\n\n#### --tag \u003ca name=\"tag\"\u003e\u003c/a\u003e\n\n- **optional**\n- Alias: `-t`\n- Default: `latest` (string)\n- Example:\n  - `ng deploy` – Docker Image is build with the tag `latest`, e.g.`account/image-name:latest`\n  - `ng deploy --tag=v1.0.0` – Docker Image is build with the tag `v1.0.0`\n\n## 📁 Configuration File \u003ca name=\"configuration-file\"\u003e\u003c/a\u003e\n\nTo avoid all these command-line cmd options, you can write down your configuration in the `angular.json` file in the `options` attribute of your deploy project's architect. Just change the kebab-case to lower camel case. This is the notation of all options in lower camel case:\n\n- baseHref\n- buildTarget\n- noBuild\n- imageName\n- account\n- tag\n\nA list of all available options is also available [here](https://github.com/kauppfbi/ngx-deploy-docker/blob/master/src/deploy/schema.json).\n\nExample:\n\n```sh\nng deploy --build-target=\u003capp\u003e:build:production --tag=next\n```\n\nbecomes\n\n```json\n\"deploy\": {\n  \"builder\": \"ngx-deploy-docker:deploy\",\n  \"options\": {\n    \"buildTarget\": \"\u003capp\u003e:build:production\",\n    \"tag\": \"next\"\n  }\n}\n```\n\nAnd just run `ng deploy` 😄.\n\n## 🏁 Next milestones \u003ca name=\"milestones\"\u003e\u003c/a\u003e\n\n- Setup of CI/CD Pipeline for the project\n- Code Restructuring:\n  - Modularization of Schematics and Builders\n  - Use what you need\n- Testing, Testing, Testing:\n  - Manual tests on different clients with different OS\n  - Unit and Integration Tests\n- Add more options to the deploy builder, what do you need?\n- Integration in NxWorkspace\n- 💅 Kubernetes deployment right from the CLI\n- preparing examples of `how to use the package in CI environment with different Providers for private registries`\n- your feature that's not on the list yet?\n\nWe look forward to any help. PRs are welcome! 😃\n\n## License\n\nCode released under the [MIT license](LICENSE).\n\n\u003chr\u003e\n\n# Attribution\n\n## 🚀 Powered By [ngx-deploy-starter](https://github.com/angular-schule/ngx-deploy-starter)\n\n## 🔥 Many things have been taken over from [transloco](https://github.com/ngneat/transloco)\n\n[npm-url]: https://www.npmjs.com/package/ngx-deploy-docker\n[npm-image]: https://badge.fury.io/js/ngx-deploy-docker.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauppfbi%2Fngx-deploy-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkauppfbi%2Fngx-deploy-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauppfbi%2Fngx-deploy-docker/lists"}