Skip to content

benjanderson/Fabric.Cashmere

 
 

Repository files navigation

Build Status

Cashmere Banner

An angular component library that makes any task feel luxurious.

Guidelines for Contribution

In order for a contribution to be considered, the following conditions must be met:

  • ng lint should result in All files pass linting
    • note: for purposes of aot compilation, strict null checking has been enabled
  • ng test should result in all tests passing
  • New components and directives must be accompanied by a component demonstrating the functionality. This component should be added to the demo app's routes
  • New components and directives must be accompanied by unit tests demonstrating that it functions as intended.
  • The component should adhere to the Health Catalyst style

Helpful tips

  • Certain libraries (like momentjs and lodash) if used by your components will need to be added to the globals object used by rollup.config.js

Recommended Development Flow

  • Branch from master
  • Ensure all linting and tests pass
  • Develop new component or feature
  • Ensure all linting and tests pass
  • Package the library npm run package
  • Run npm link from the dist folder
  • In another angular application run npm link @healthcatalyst/cashmere
  • Ensure external application can do a production/aot build ng build --prod
  • Submit pull request

Packaging the Library

Run npm run package to bundle the library.

Running the Demo App

Run ng serve to begin serving the demo application on port 4200

Running unit tests

Run ng test to execute the unit tests via Karma.

About

An angular component library that makes any task feel luxurious.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 61.9%
  • HTML 21.6%
  • CSS 11.6%
  • JavaScript 4.7%
  • Shell 0.2%