Document-center-ang NPM

Angular Base Seed Repository

This application defines a basic seed repository for Angular/Backbase Web UI applications at Citizens.

This seed angular base can be used for development of an angular component or a Backbase widget.

Seed Repository Information / Justifications / Roadmap

(You may or may not want to keep this section in your app).

Running unit tests

npm test will run tests via Karma.

Running end-to-end tests

npm run e2e execute the end-to-end tests via Protractor.

Linting via TSLINT

Rules have been defined in tslint.json, providing lint checking for Typescript code.

You can run npm run lint to have TSLint validate these rules.

For a list of TSLint rules and definitions: https://palantir.github.io/tslint/rules/

Generating Documentation

Running npm run docs will run both CompoDoc generator. The generated documentation will be available in the /docs/ directory.

For details on adding CompoDoc supported comments to your code: https://compodoc.app/guides/comments.html
For details on using Compodoc features: https://compodoc.app/guides/getting-started.html

Package your App

npm run package:apps:cx will package the application.

More details

the npm run build will build the application and build artifacts will be stored in the dist/ directory

Scripts / Tools Included

npm test # <-- runs tests
npm run cb_dev start:dev:plain # <-- command to launch your app for development

Making your own application from this seed repo

Git clone it, or fork it:
- The easy way? Download and run fork.bat or fork.sh, giving it your new project's path on disk and the clone URL of a new Bitbucket repository you created.
- The slightly harder / more manual way? Use the fork button on Bitbucket and set up master, develop branches.
Edit package.json, changing the name, author, description.
Add any dependencies you need.
Update artifact name using ./bin/propegate-artifact-name.ps1 e.g. powershell bin\propegate-artifact-name.ps1 YOUR_PROJECT_NAME
Update this README.md, if required.
Push it to a new repository.

When you need to pull in the latest changes from this seed repo to your project, you can use the update command as part of cb_dev.

Application Specific Instructions (seed-angular-base derived application)

(Assuming you delete all or most of the stuff above for you microservice, and maybe you should, you should keep + edit the below parts, as they apply for everything)

Configuring this application to run on your machine

$ npm install

Running this application

Use $ npm start to run the staging version in local machine
To run application in CX, package the app using npm run package:apps:cx and import using npm run import_package

Source

$ npm run build