Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.48 KB

README.md

File metadata and controls

63 lines (37 loc) · 1.48 KB

angular-express-header

Angular Express boilerplate to create a reusable Angular Express component.

How to get started

Ensure the Angular Express CLI tool is installed:

$ npm install -g ngx-cli

Create a new component directory:

$ mkdir new-component
$ cd new-component

Initialize the component boilerplate:

$ ngx init -b component

Visit the AngularJS Express page to learn more about boilerplates and components.

How to publish the component

Simply push the component to a GitHub repository.

How to use the component in a project

From a project root:

$ ngx install github-username/github-repository-name

This will copy all files in the ngx directory of the component to the src/components/github-repository-name directory.

To manually specify the destination:

$ ngx install github-username/github-repository-name src/components/custom-component-name

The ngx directory

The ngx directory contains all files that are scaffolded when the component is installed.

This allows other files to be included in the repository e.g. README.md without including them in an actual install.

License

MIT

Change log

v1.0.0

  • Added modular structure