initial checkin

Author: santoshyadavdev

.circleci/config.yml

@@ -0,0 +1,27 @@
+version: 2
+
+jobs:
+  build:
+
+    docker:
+      - image: circleci/node:12-browsers
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          key: dependency-cache-{{ checksum "src/package.json" }}
+      - run: cd src && npm i --silent
+      - save_cache:
+          key: dependency-cache-{{ checksum "src/package.json" }}
+          paths:
+            - src/node_modules
+      - run: cd src && npm run build
+      - run: cd src && npm run test
+      - run: cd src/dist && sudo npm link
+
+      - run: sudo -E npm install -g @angular/cli@next
+      - run: sudo -E ng new your-angular-project --defaults
+      - run: cd your-angular-project && sudo -E npm link ngx-deploy-starter
+      - run: cd your-angular-project && sudo -E ng add ngx-deploy-starter
+      - run: cd your-angular-project && sudo -E ng deploy

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,27 @@
+node_modules
+.tmp
+.sass-cache
+.DS_Store
+.bash_history
+*.swp
+*.swo
+*.d.ts
+
+*.classpath
+*.project
+*.settings/
+*.classpath
+*.project
+*.settings/
+
+.vim/bundle
+nvim/autoload
+nvim/plugged
+nvim/doc
+nvim/swaps
+nvim/colors
+dist
+
+/src/mini-testdrive/404.html
+/src/mini-testdrive/CNAME
+.angulardoc.json

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest Tests",
+      "type": "node",
+      "request": "launch",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/src/node_modules/.bin/jest",
+        "--runInBand"
+      ],
+      "cwd": "${workspaceFolder}/src",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "port": 9229
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "npm",
+            "script": "build",
+            "path": "src/",
+            "label": "npm build"
+        }
+    ]
+}

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Minko Gechev, Johannes Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,84 @@
+# @angular-schule/ngx-deploy-starter 🚀
+[![NPM version][npm-image]][npm-url]
+[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?color=blue&style=flat-square)](http://opensource.org/licenses/MIT)
+
+![Banner](docs/ng-deploy-starter-project.jpg)
+
+## About
+
+This is a sample project that helps you to implement your own __deployment builder__ (`ng deploy`) for the Angular CLI.
+The groundwork of this starter was provided by Minko Gechev's [ngx-gh project](https://github.com/mgechev/ngx-gh).
+
+This project has the following purposes:
+
+1. To promote the adoption of `ng deploy`.
+2. To clarify various questions and to standardise the experience of the various builders.  
+
+We hope for an inspiring discussion, pull requests and questions.
+
+**If you don't know `ng deploy` yet, learn more about this command here:  
+[👉 Blogpost: All you need to know about `ng deploy`](https://angular.schule/blog/2019-08-ng-deploy)**  
+
+## Essential considerations
+
+There are still differences between the existing builders. 
+Let's find some rules that everyone agrees with. Here are two proposals.
+
+### 1. A deployment builder must always compile the project before the deployment
+
+To reduce the chances to deploy corrupted assets, it's important to build the app right before deploying it. ([source](https://github.com/angular-schule/website-articles/pull/3#discussion_r315802100))
+
+**Current state:**  
+Currently there are existing deployment builders that only build in production mode.
+This might be not enough.
+There is also the approach not to perform the build step at all.
+
+**Our suggestion:**  
+By default, a deployment builder **shall** compile in `production` mode, but it **should** be possible to override the default configuration using the option `--configuration`.
+
+Discussion: https://github.com/angular-schule/ngx-deploy-starter/issues/1
+
+### 2. A deployment builder should have an interactive prompt after the "ng add".
+
+To make it easier for the end user to get started, a deployment builder **should** ask for all the mandatory questions immediately after the `ng add`.
+The data should be persisted in the `angular.json` file.
+
+**Note:**  
+This feature is not implemented for this starter yet, but we are looking forward to your support.
+
+Discussion: https://github.com/angular-schule/ngx-deploy-starter/issues/2
+
+### 3. More to come
+
+What's bothers you about this example?
+We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-starter/issues)!
+
+
+## How to make your own deploy builder
+
+1. fork this repository
+2. adjust the `package.json`
+3. search and replace for the string `@angular-schule/ngx-deploy-starter` and `ngx-deploy-starter` and choose your own name.
+4. search and replace for the string `to the file system` and name your deploy target.
+5. add your deployment code to `src/engine/engine.ts`, take care of the tests
+6. follow the instructions from the [contributors README](docs/README_contributors.md) for build, test and publishing.
+
+
+You are free to customise this project according to your needs.
+Please keep the spirit of Open Source alive and use the MIT or a compatible license.
+
+
+## Projects based on ngx-deploy-starter
+ 
+* [ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm) – Deploy your Angular Package to NPM directly from the Angular CLI! 🚀
+* [angular-cli-ghpages](https://github.com/angular-schule/angular-cli-ghpages) – Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
+
+
+
+
+## License
+Code released under the [MIT license](LICENSE).
+
+
+[npm-url]: https://www.npmjs.com/package/@angular-schule/ngx-deploy-starter
+[npm-image]: https://badge.fury.io/js/%40angular-schule%2Fngx-deploy-starter.svg

docs/README_contributors.md

@@ -0,0 +1,130 @@
+# @angular-schule/ngx-deploy-starter: README for contributors
+
+## How to start <a name="start"></a>
+
+tl;dr – execute this:
+
+```
+cd src
+npm i
+npm run build
+npm test
+```
+
+
+## Local development
+
+If you want to try the latest package locally without installing it from NPM, use the following instructions.
+This may be useful when you want to try the latest non-published version of this library or you want to make a contribution.
+
+Follow the instructions for [checking and updating the Angular CLI version](#angular-cli) and then link the package.
+
+
+### 1. Angular CLI
+
+1. Install the next version of the Angular CLI.
+
+   ```sh
+   npm install -g @angular/cli
+   ```
+
+2. Run `ng version`, make sure you have installed Angular CLI v8.3.0 or greater.
+
+3. Update your existing project using the command:
+
+   ```sh
+   ng update @angular/cli @angular/core
+   ```
+
+
+### 2. npm link
+
+Use the following instructions to make `@angular-schule/ngx-deploy-starter` available locally via `npm link`.
+
+1. Clone the project
+
+   ```sh
+   git clone https://github.com/angular-schule/ngx-deploy-starter.git
+   cd ngx-deploy-starter
+   ```
+
+2. Install the dependencies
+
+   ```sh
+   cd src
+   npm install
+   ```
+
+3. Build the project:
+
+   ```sh
+   npm run build
+   ```
+
+4. Create a local npm link:
+
+   ```sh
+   cd dist
+   npm link
+   ```
+
+Read more about the `link` feature in the [official NPM documentation](https://docs.npmjs.com/cli/link).
+
+
+### 3. Adding to an Angular project -- ng add
+
+Once you have completed the previous steps to `npm link` the local copy of `@angular-schule/ngx-deploy-starter`, follow these steps to use it in a local Angular project.
+
+1. Enter the project directory
+
+   ```sh
+   cd your-angular-project
+   ```
+
+2. Add the local version of `@angular-schule/ngx-deploy-starter`.
+
+   ```sh
+   npm link @angular-schule/ngx-deploy-starter
+   ```
+
+3. Now execute the `ng-add` schematic.
+
+   ```sh
+   ng add @angular-schule/ngx-deploy-starter
+   ```
+
+4. You can now deploy your angular app to GitHub pages.
+
+   ```sh
+   ng deploy
+  ```
+
+   Or with the old builder syntax:
+
+   ```sh
+   ng run your-angular-project:deploy
+   ```
+
+5. You can remove the link later by running `npm unlink`
+
+
+### 4. Testing
+
+Testing is done with [Jest](https://jestjs.io/).
+To run the tests:
+
+```sh
+cd ngx-deploy-starter/src
+npm test
+```
+
+
+
+## Publish to NPM
+
+```
+cd ngx-deploy-starter/src
+npm run build
+npm run test
+npm publish dist --access public
+```