Skip to content
This repository was archived by the owner on Jan 26, 2024. It is now read-only.

Commit ec440ef

Browse files
committed
docs: updated README
new text for RFCs
1 parent d80073b commit ec440ef

File tree

1 file changed

+15
-46
lines changed

1 file changed

+15
-46
lines changed

README.md

Lines changed: 15 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,28 @@
11
# @angular-schule/ngx-deploy-starter 🚀
2+
23
[![NPM version][npm-image]][npm-url]
34
[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?color=blue&style=flat-square)](http://opensource.org/licenses/MIT)
45

56
![Banner](docs/ng-deploy-starter-project.jpg)
67

78
## About
89

9-
This is a sample project that helps you to implement your own __deployment builder__ (`ng deploy`) for the Angular CLI.
10+
This is a sample project that helps you to implement your own **deployment builder** (`ng deploy`) for the Angular CLI.
1011
The groundwork of this starter was provided by Minko Gechev's [ngx-gh project](https://github.com/mgechev/ngx-gh).
1112

1213
This project has the following purposes:
1314

14-
1. To promote the adoption of `ng deploy`.
15-
2. To clarify various questions and to standardise the experience of the various builders.
15+
**Goal 1:** To promote the adoption of `ng deploy` by providing a blueprint for new builders.
16+
**Goal 2:** To clarify various questions and to standardise the experience of the existing builders.
1617

1718
We hope for an inspiring discussion, pull requests and questions.
1819

1920
**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.
21+
[👉 Blogpost: All you need to know about `ng deploy`](https://angular.schule/blog/2019-08-ng-deploy)**
4522

46-
**Note:**
47-
This feature is not implemented for this starter yet, but we are looking forward to your support.
23+
## Goal 1: How to make your own deploy builder
4824

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
25+
We are there to assist you in creating a builder.
5826

5927
1. fork this repository
6028
2. adjust the `package.json`
@@ -63,22 +31,23 @@ We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-start
6331
5. add your deployment code to `src/engine/engine.ts`, take care of the tests
6432
6. follow the instructions from the [contributors README](docs/README_contributors.md) for build, test and publishing.
6533

66-
6734
You are free to customise this project according to your needs.
6835
Please keep the spirit of Open Source alive and use the MIT or a compatible license.
6936

37+
## Goal 2: Best practices for deployment builders
7038

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-
39+
This project also aims to be a reference for the existing builders.
40+
Recommendations are made through RFCs (Request for Comments), and we are very pleased about their adoption.
41+
[Here is a list of all existing RFCs](https://github.com/angular-schule/ngx-deploy-starter/issues?q=is%3Aissue+%5BRFC%5D).
7642

43+
## Projects based on ngx-deploy-starter
7744

45+
- [ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm) – Deploy your Angular Package to NPM directly from the Angular CLI! 🚀
46+
- [angular-cli-ghpages](https://github.com/angular-schule/angular-cli-ghpages) – Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
7847

7948
## License
80-
Code released under the [MIT license](LICENSE).
8149

50+
Code released under the [MIT license](LICENSE).
8251

8352
[npm-url]: https://www.npmjs.com/package/@angular-schule/ngx-deploy-starter
8453
[npm-image]: https://badge.fury.io/js/%40angular-schule%2Fngx-deploy-starter.svg

0 commit comments

Comments
 (0)