first release to NPM as @angular-schule/ngx-deploy-starter

renamed to show how scoped packages work (which is likely to be used more often)

Author: JohannesHoppe

README.md

@@ -1,4 +1,4 @@
-# ngx-deploy-starter
+# @angular-schule/ngx-deploy-starter 🚀
 
 ## About
 
@@ -50,7 +50,7 @@ We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-start
 
 1. fork this repository
 2. adjust the `package.json`
-3. search and replace for the string `ngx-deploy-starter` and choose your own name.
+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.

docs/README_contributors.md

@@ -1,4 +1,4 @@
-# ngx-deploy-starter: README for contributors
+# @angular-schule/ngx-deploy-starter: README for contributors
 
 ## How to start <a name="start"></a>
 
@@ -39,7 +39,7 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
 
 ### 2. npm link
 
-Use the following instructions to make `ngx-deploy-starter` available locally via `npm link`.
+Use the following instructions to make `@angular-schule/ngx-deploy-starter` available locally via `npm link`.
 
 1. Clone the project
 
@@ -73,29 +73,34 @@ Read more about the `link` feature in the [official NPM documentation](https://d
 
 ### 3. Adding to an Angular project -- ng add
 
-Once you have completed the previous steps to `npm link` the local copy of `ngx-deploy-starter`, follow these steps to use it in a local Angular project.
+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 `ngx-deploy-starter`.
+2. Add the local version of `@angular-schule/ngx-deploy-starter`.
 
    ```sh
-   npm link ngx-deploy-starter
+   npm link @angular-schule/ngx-deploy-starter
    ```
 
 3. Now execute the `ng-add` schematic.
 
    ```sh
-   ng add ngx-deploy-starter
+   ng add @angular-schule/ngx-deploy-starter
    ```
 
 4. You can now deploy your angular app to GitHub pages.
 
    ```sh
+   ng deploy
+  ```
+
+   Which is the same as:
+   ```
    ng run your-angular-project:deploy
    ```
 
@@ -120,5 +125,5 @@ npm test
 cd ngx-deploy-starter/src
 npm run build
 npm run test
-npm publish dist
+npm publish dist --access public
 ```

src/README.md

@@ -1,4 +1,4 @@
-# ngx-deploy-starter
+# @angular-schule/ngx-deploy-starter
 
 **Deploy your Angular app to the file system directly from the Angular CLI! 🚀**
 
@@ -11,10 +11,10 @@
 
 ## Usage
 
-Add `ngx-deploy-starter` to your project.
+Add `@angular-schule/ngx-deploy-starter` to your project.
 
 ```bash
-ng add ngx-deploy-starter
+ng add @angular-schule/ngx-deploy-starter
 ```
 
 Deploy your project to the file system.

src/collection.json

@@ -2,7 +2,7 @@
   "$schema": "@angular-devkit/schematics/collection-schema.json",
   "schematics": {
     "ng-add": {
-      "description": "Add ngx-deploy-starter deploy schematic",
+      "description": "Add @angular-schule/ngx-deploy-starter deploy schematic",
       "factory": "./ng-add#ngAdd"
     }
   }

src/deploy/schema.json

@@ -1,7 +1,7 @@
 {
   "id": "Schema",
   "title": "schema",
-  "description": "Deployment of Angular CLI applications to GitHub pages (ngx-deploy-starter)",
+  "description": "Deployment of Angular CLI applications to the file system",
   "properties": {
     "baseHref": {
       "type": "string",

src/engine/engine.ts

@@ -16,7 +16,7 @@ export async function run(dir: string, options: Schema, logger: logging.LoggerAp
 
     await fse.copy(dir, options.targetDir)
 
-    logger.info('🚀 Successfully published via ngx-deploy-starter! Have a nice day!');
+    logger.info('🚀 Successfully published via @angular-schule/ngx-deploy-starter! Have a nice day!');
   }
   catch (error) {
     logger.error('❌ An error occurred!');

src/ng-add.spec.ts

@@ -170,7 +170,7 @@ const initialAngularJson = `{
           }
         },
         \"deploy\": {
-          \"builder\": \"ngx-deploy-starter:deploy\",
+          \"builder\": \"@angular-schule/ngx-deploy-starter:deploy\",
           \"options\": {}
         }
       }
@@ -202,7 +202,7 @@ const overwriteAngularJson = `{
           }
         },
         \"deploy\": {
-          \"builder\": \"ngx-deploy-starter:deploy\",
+          \"builder\": \"@angular-schule/ngx-deploy-starter:deploy\",
           \"options\": {}
         }
       }
@@ -234,7 +234,7 @@ const projectAngularJson = `{
           }
         },
         \"deploy\": {
-          \"builder\": \"ngx-deploy-starter:deploy\",
+          \"builder\": \"@angular-schule/ngx-deploy-starter:deploy\",
           \"options\": {}
         }
       }

src/ng-add.ts

@@ -79,7 +79,7 @@ export const ngAdd = ({ project: DeployOptions }) => (
   }
 
   project.architect['deploy'] = {
-    builder: 'ngx-deploy-starter:deploy',
+    builder: '@angular-schule/ngx-deploy-starter:deploy',
     options: {}
   };
 

src/package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "ngx-deploy-starter",
+  "name": "@angular-schule/ngx-deploy-starter",
   "version": "0.0.1",
-  "description": "Deployment from the Angular CLI to the file system. This is a sample project that helps you to implement your own deployment builder (ng deploy) for the Angular CLI.",
+  "description": "Deployment from the Angular CLI to the file system. This is a sample project that helps you to implement your own deployment builder (`ng deploy`) for the Angular CLI.",
   "main": "index.js",
   "scripts": {
     "build": "rimraf dist && json2ts deploy/schema.json > deploy/schema.d.ts && tsc && copyfiles README.md builders.json collection.json package.json ngx-deploy-starter deploy/schema.json dist",