@dxc-technology/halstack-angular

Halstack Angular CDK

Halstack Angular CDK is a npm library of reusable Angular components, made with the purpose of helping Angular developers with the task of implementing User Interfaces following the DXC Design Guidelines.

• It increases visual and behavioral consistency across the applications using the library.
• It cuts down development efforts, taking the responsability of following the Design Guidelines away from the developer, and allowing him to focus on providing business value.

Usage

Halstack Angular CDK is a set of reusable components distributed as a npm library. See the documentation site for details on how to use it.

Contributing

Before opening new issues or pull requests, please refer to CONTRIBUTING.MD.

Development Setup

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

The project is divided in two main folders. One is for the actual library, and the other one is a Angular application using the library.

Library

Contained in the projects\dxc-ngx-cdk.

cd projects\dxc-ngx-cdk

Install the library dependencies.

npm install

Run the build process into dist folder, detecting and automatically building changes in src.

npm run build-lib:watch

Once the build is done copy the necessary files.

npm run post-build-lib

or

npm run post-build-lib-win

for windows based terminals.

Or if there is no need to watch for changes, run the build process and pack it to generate the library.

npm run generate-lib

or

npm run generate-lib-win

for windows based terminals.

Documentation Application

Contained in projects\dxc-ngx-cdk-site folder.

Install the application dependencies.

npm install

The Halstack Angular CDK needs to be linked to the application (from the folder dist\dxc-ngx-cdk). This one must have been previously built as shown before.

npm run link-lib

or

npm run unlink-lib

in case it needs to be unlinked.

You can create your own application and link it to the dist folder.

npm link PATH-TO-DIST-FOLDER

Start the application

npm run start

If you are watching for changes, anytime you make a change to the library or the app, angular cli will live-reload your local dev server so you can iterate on your component in real-time.

Running the test

Run the tests from the library folder projects\dxc-ngx-cdk after the library dependencies have been installed.

cd projects\dxc-ngx-cdk
npm run test