Skip to content

Latest commit

 

History

History
148 lines (86 loc) · 2.98 KB

README.md

File metadata and controls

148 lines (86 loc) · 2.98 KB
Raw

angular-express-header

Command line tool for AngularJS Express.

Installation

$ npm install -g ngx-cli

Commands

ngx init

Initialize a boilerplate to kickstart a project:

$ ngx init [options] [target-directory]

Options

-b, --boilerplate <boilerplate>

Boilerplate to initialize.

Format: [<github-username>/]<github-repository-name>.

  • if no boilerplate is specified, ngx-boilerplates/default is used
  • if only a <github-repository-name> is specified, ngx-boilerplates/<github-repository-name> is used
-f, --force

Overwrite existing file(s).

-h, --help

Output usage information.

Arguments

<target-directory>

Where to initialize the boilerplate.

  • if no target-directory is specified, the current directory is used

Examples

# Initialize ngx-boilerplates/default in current directory
$ ngx init

# Initialize ngx-boilerplates/default in directory new-project
$ ngx init new-project

# Initialize ngx-boilerplates/default in current directory
$ ngx init -b default

# Initialize github-username/github-repository-name in current directory
$ ngx init -b github-username/github-repository-name

Visit ngx-boilerplates for a list of official boilerplates.

ngx install

Install a component in an existing project:

$ ngx install [options] <component> [target-directory]

Options

-f, --force

Overwrite existing file(s).

-h, --help

Output usage information.

Arguments

<component>

Component to install.

Format: [<github-username>/]<github-repository-name>

  • if only a <github-repository-name> is specified, ngx-components/<github-repository-name> is used
<target-directory>

Where to install the component.

  • if no target-directory is specified, src/components is used

Examples

# Install ngx-components/angular-ui-router-component in src/components/angular-ui-router-component
$ ngx install angular-ui-router-component

# Install ngx-components/angular-ui-router-component in src/components/homepage
$ ngx install angular-ui-router-component src/components/homepage

# Install github-username/foo in src/components/foo
$ ngx install github-username/foo

# Install github-username/foo in src/components/bar
$ ngx install github-username/foo in src/components/bar

Visit ngx-components for a list of official components.

License

MIT

Change log

v1.9.0

  • Updated dependencies to work nicely with Node v4.

v1.5.0

  • Removed compile command

v1.4.0

  • Removed Harp dependency
  • Updated documentation

v1.2.0

  • Added compile command
  • Updated documentation

v1.0.0

  • Added support for installing components in src/components by default
  • Updated documentation

v0.1.0

  • Initial version