|
1 | | -# @angular-schule/ngx-deploy-starter 🚀 |
2 | | -[![NPM version][npm-image]][npm-url] |
3 | | -[](http://opensource.org/licenses/MIT) |
4 | | - |
5 | | - |
6 | | - |
7 | | -## About |
8 | | - |
9 | | -This is a sample project that helps you to implement your own __deployment builder__ (`ng deploy`) for the Angular CLI. |
10 | | -The groundwork of this starter was provided by Minko Gechev's [ngx-gh project](https://github.com/mgechev/ngx-gh). |
11 | | - |
12 | | -This project has the following purposes: |
13 | | - |
14 | | -1. To promote the adoption of `ng deploy`. |
15 | | -2. To clarify various questions and to standardise the experience of the various builders. |
16 | | - |
17 | | -We hope for an inspiring discussion, pull requests and questions. |
18 | | - |
19 | | -**If you don't know `ng deploy` yet, learn more about this command here: |
20 | | -[👉 Blogpost: All you need to know about `ng deploy`](https://angular.schule/blog/2019-08-ng-deploy)** |
21 | | - |
22 | | -## Essential considerations |
23 | | - |
24 | | -There are still differences between the existing builders. |
25 | | -Let's find some rules that everyone agrees with. Here are two proposals. |
26 | | - |
27 | | -### 1. A deployment builder must always compile the project before the deployment |
28 | | - |
29 | | -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)) |
30 | | - |
31 | | -**Current state:** |
32 | | -Currently there are existing deployment builders that only build in production mode. |
33 | | -This might be not enough. |
34 | | -There is also the approach not to perform the build step at all. |
35 | | - |
36 | | -**Our suggestion:** |
37 | | -By default, a deployment builder **shall** compile in `production` mode, but it **should** be possible to override the default configuration using the option `--configuration`. |
38 | | - |
39 | | -Discussion: https://github.com/angular-schule/ngx-deploy-starter/issues/1 |
40 | | - |
41 | | -### 2. A deployment builder should have an interactive prompt after the "ng add". |
42 | | - |
43 | | -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`. |
44 | | -The data should be persisted in the `angular.json` file. |
45 | | - |
46 | | -**Note:** |
47 | | -This feature is not implemented for this starter yet, but we are looking forward to your support. |
48 | | - |
49 | | -Discussion: https://github.com/angular-schule/ngx-deploy-starter/issues/2 |
50 | | - |
51 | | -### 3. More to come |
52 | | - |
53 | | -What's bothers you about this example? |
54 | | -We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-starter/issues)! |
55 | | - |
56 | | - |
57 | | -## How to make your own deploy builder |
58 | | - |
59 | | -1. fork this repository |
60 | | -2. adjust the `package.json` |
61 | | -3. search and replace for the string `@angular-schule/ngx-deploy-starter` and `ngx-deploy-starter` and choose your own name. |
62 | | -4. search and replace for the string `to the file system` and name your deploy target. |
63 | | -5. add your deployment code to `src/engine/engine.ts`, take care of the tests |
64 | | -6. follow the instructions from the [contributors README](docs/README_contributors.md) for build, test and publishing. |
65 | | - |
66 | | - |
67 | | -You are free to customise this project according to your needs. |
68 | | -Please keep the spirit of Open Source alive and use the MIT or a compatible license. |
69 | | - |
70 | | - |
71 | | -## Projects based on ngx-deploy-starter |
72 | | - |
73 | | -* [ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm) – Deploy your Angular Package to NPM directly from the Angular CLI! 🚀 |
74 | | -* [angular-cli-ghpages](https://github.com/angular-schule/angular-cli-ghpages) – Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀 |
75 | | - |
76 | | - |
77 | | - |
78 | | - |
79 | | -## License |
80 | | -Code released under the [MIT license](LICENSE). |
81 | | - |
82 | | - |
83 | | -[npm-url]: https://www.npmjs.com/package/@angular-schule/ngx-deploy-starter |
84 | | -[npm-image]: https://badge.fury.io/js/%40angular-schule%2Fngx-deploy-starter.svg |
| 1 | +# Coming Soon |
0 commit comments