ng-module-template v1.0.18
ng-module-template
A template for building Angular applications or re-usable Angular modules that you can publish to npm. This template is Angular5 compatible.
Install
sdfsdfs
git clone https://github.com/angular-patterns/ng-module-template.git sdf
cd ng-module-template
npm install
Development
Opens webpack-dev-server on port 8080 for development:
npm run dev
If you are building a reusable Angular module, you will also have to export any compnents, pipes, services, etc from src\public_api.ts. This will allow users of your module to import those sybmols directly.
For example, if you want to export MyComponent, then modify public_api.ts:
export { MyComponent } from 'app/my.component';
Users of your module can then import the component:
import { MyComponent } from 'ng-module-template'
Test
There are three type of tests:
- Unit Tests -
npm run test - e2e Tests -
npm run e2e - lint Tests -
npm run lint
Production Builds
You have two options for a production build:
Angular Application - outputs to the
distfolder.npm run buildReusable Angular Module - outputs to the
distfolder.npm run build-module
Deployment
There are two options for deployment.
Publish to local file system
npm run publish-local- publishes from thedistfolder toc:\packages.The folder can be customized using a
destparameter:npm run publish -- --dest c:\custom-folderPublish to npm
npm publishFollow the publish instructions from npm: https://docs.npmjs.com/getting-started/publishing-npm-packages
Building Reusable Angular Modules
Rename the module before you publish:
npm run name-module -- --name my-module
git add *
git commit -m "renamed module from ng-module-template to my-module"
Optional Versioning:
npm version patch
Then publish:
npm run publish-local
or
npm publish
Installing your Published Module
If you published locally:
npm install c:\packages\my-module --save
If you published to npm:
npm install my-module --save
Yeah yeah
Blah baljdlksfjsd