ngx-template-seed

Seed project for creating redistributable Angular modules

Getting started

• clone the repo to your local machine
• Run npm install in the root directory.
• Run npm run new [Insert Plugin Name Here] (only run this once when cloning the template repo)
• Enjoy.

Development:

Work flow

• Clone repository to your machine.

• Live edit mode with npm run serve. (goes into the project director and run's ng serve)

• Run tests with watcher with npm run test. (goes into the project director and run's ng test)

• Prepare for distrabution with npm run prepare.dist after which you can publish to npm with run npm publish

• Test a demo project using the exported ngModule with npm run demo (prepares the project for distrabution and then goes into the demo directory and runs ng serve)

• Run npm run setup to prepare the project. (runs npm install in the demo and main project directory)

• Optionally you can use https://github.com/angular-buch/angular-cli-ghpages to publish the demo install to github pages. by first running npm run demo then going into your demo directory with cd demo and from their you can copy and past the two commands to publish to github pages.

  ng build --prod --aot --base-href "https://USERNAME.github.io/YOUR-REPO-NAME/"
  

  then

  ngh --repo=https://github.com/USERNAME/YOUR-REPO-NAME.git
  

Requirements

• angular-cli 1.0.0 rc.0 or higher
• node 6.9.0 or higher

Contributors

Josh Sommer	Jeff Beck