my-eing-footer v1.0.0
eing-footer
Description:
This module is used to show Footer on the Page.
To use this module import eing-footer and add this tag in the html/component \<eing-footer>\</eing-footer>
Prerequisites:
nodejs must be installed.
Dependent feature/utility modules should be available in the private npm registry.
Setup comcast NPM Registry:
This setup is one-time process and common/required for all types of eing-* modules.
npm config set registry https://artifactory.io.comcast.net/api/npm/npm-all
npm config set @angular:registry https://registry.npmjs.org/
npm config set @types:registry https://registry.npmjs.org/
npm config set @ngtools:registry https://registry.npmjs.org/
npm config set @ngrx:registry https://registry.npmjs.org/
npm install protractor@5.1.1
webdriver-manager update
Build Process:
npm start
- To bootstrap the module on your local machine, in non-production mode.
npm run build
- It will produce a dist named as "footer". Now we can place this dist on any server to run it.
It will execute in production mode.
Running Unit Tests:
Run
npm run unit:test
.It will create the coverage report in coverage folder and test report in karmaUnitTestReport folder.
Running e2e Tests:
Run
protractor
It will create the report in protractorReports folder.
How to publish:
If the project/module is already published, please unpublish it first. To unpublish you can use
npm unpublish -f
ornpm unpublish -f <module_name>
ornpm unpublish -f <module_name@version>
Run
npm publish
to publish a latest package.Verify on private npm registry/artifactory web console (https://artifactory.io.comcast.net/webapp/).
Runner
1. To make this module self runnable we are using Runner which could be found under "runner"
folder on the root of the application.
Whenever we introduce new dependencies for the module please also refer to the
systemjs.conf.js
file for updating the references.Please note, whenever we build package of the application using
npm run build
thisRunner
is not included in the packaged file i-e *.umd.js because currently this is only used for development purpose and to run functional test cases on individual features.
Rollup / Tree Shaking
1. Whenever we import new external dependency in our source files we would also have to define those dependencies in globals
and external
array of rollup.conf.js
Gulp
1. We are using gulp to inline our scss
and html
files while using typescript to compile our code into js format with the help of tsconfig.json
We are also using
gulp-watch
which helps us in smooth development and fasterts to js
compilation at development time.We are using gulp mainly for generating module specific distribution which should be deployable in any external server. e-g For
eing-<MODULE_NAME>
, it will generate<MODULE_NAME>
Note:
Whenever any dependency is changed then delete the dependency of that project from node_modules of app manually before running npm start
or npm run build
or npm run unit:test
or protractor
.
7 years ago