|
1 | 1 | # <%= classify(name) %>
|
2 | 2 |
|
3 |
| -This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version <%= angularLatestVersion %>. |
| 3 | +This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version <%= angularLatestVersion %>. |
4 | 4 |
|
5 | 5 | ## Code scaffolding
|
6 | 6 |
|
7 |
| -Run `ng generate component component-name --project <%= name %>` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project <%= name %>`. |
8 |
| -> Note: Don't forget to add `--project <%= name %>` or else it will be added to the default project in your `angular.json` file. |
| 7 | +Angular CLI includes powerful code scaffolding tools. To generate a new component, run: |
9 | 8 |
|
10 |
| -## Build |
| 9 | +```bash |
| 10 | +ng generate component component-name |
| 11 | +``` |
11 | 12 |
|
12 |
| -Run `ng build <%= name %>` to build the project. The build artifacts will be stored in the `dist/` directory. |
| 13 | +For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run: |
13 | 14 |
|
14 |
| -## Publishing |
| 15 | +```bash |
| 16 | +ng generate --help |
| 17 | +``` |
15 | 18 |
|
16 |
| -After building your library with `ng build <%= name %>`, go to the dist folder `cd dist/<%= dasherize(name) %>` and run `npm publish`. |
| 19 | +## Building |
| 20 | + |
| 21 | +To build the library, run: |
| 22 | + |
| 23 | +```bash |
| 24 | +ng build <%= name %> |
| 25 | +``` |
| 26 | + |
| 27 | +This command will compile your project, and the build artifacts will be placed in the `dist/` directory. |
| 28 | + |
| 29 | +### Publishing the Library |
| 30 | + |
| 31 | +Once the project is built, you can publish your library by following these steps: |
| 32 | + |
| 33 | +1. Navigate to the `dist` directory: |
| 34 | + ```bash |
| 35 | + cd dist/<%= dasherize(name) %> |
| 36 | + ``` |
| 37 | + |
| 38 | +2. Run the `npm publish` command to publish your library to the npm registry: |
| 39 | + ```bash |
| 40 | + npm publish |
| 41 | + ``` |
17 | 42 |
|
18 | 43 | ## Running unit tests
|
19 | 44 |
|
20 |
| -Run `ng test <%= name %>` to execute the unit tests via [Karma](https://karma-runner.github.io). |
| 45 | +To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command: |
| 46 | + |
| 47 | +```bash |
| 48 | +ng test |
| 49 | +``` |
| 50 | + |
| 51 | +## Running end-to-end tests |
| 52 | + |
| 53 | +For end-to-end (e2e) testing, run: |
| 54 | + |
| 55 | +```bash |
| 56 | +ng e2e |
| 57 | +``` |
| 58 | + |
| 59 | +Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs. |
21 | 60 |
|
22 |
| -## Further help |
| 61 | +## Additional Resources |
23 | 62 |
|
24 |
| -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. |
| 63 | +For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. |
0 commit comments