README.md.template 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. # <%= classify(name) %>
  2. This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version <%= angularLatestVersion %>.
  3. ## Code scaffolding
  4. Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
  5. ```bash
  6. ng generate component component-name
  7. ```
  8. For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
  9. ```bash
  10. ng generate --help
  11. ```
  12. ## Building
  13. To build the library, run:
  14. ```bash
  15. ng build <%= name %>
  16. ```
  17. This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
  18. ### Publishing the Library
  19. Once the project is built, you can publish your library by following these steps:
  20. 1. Navigate to the `dist` directory:
  21. ```bash
  22. cd dist/<%= dasherize(name) %>
  23. ```
  24. 2. Run the `npm publish` command to publish your library to the npm registry:
  25. ```bash
  26. npm publish
  27. ```
  28. ## Running unit tests
  29. To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
  30. ```bash
  31. ng test
  32. ```
  33. ## Running end-to-end tests
  34. For end-to-end (e2e) testing, run:
  35. ```bash
  36. ng e2e
  37. ```
  38. Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
  39. ## Additional Resources
  40. 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.