@alixpartners/ui-components

AlixPartners UI Components

install:

npm i @alixpartners/ui-components --save

scripts:

storybook:

npm run storybook

storybook:manual-deploy

Runs storybook:build && node script to zip up storybook-static and push to Azure more about storybook:manual-deploy here

npm run storybook:manual-deploy

build:

npm run build

jest:

npm run test | npm run test:watch | npm run test:coverage

tslint:

npm run tslint | npm run tslint:fix

Change Log

For more information about each release check the Change Log

Deployment

There is no deployment pipeline for Component Library but you can manually push to npm using npm publish If you are not part of the Alix Partners organisation on npm contact Shaun Hinchy.

Development

• Create a feature branch for your work.
• Add your new component to src/index.ts so it's exported by the build.
• Update the Change Log
• If you are unsure if your PR will be approved on the same day you can leave the date and package version as 1.x.x (x, x, x)

After PR approval

• Pull from master
• Update date and package version in the Change Log
• Bump the version in package.json
• Double check again that the component has been added to src/index.ts
• run the build npm run build
• Commit the changes with release 1.x.x (replace x.x with actual version number)
• Publish to npm npm publish

Normally it's a good idea to run a manual deploy on storybook too so it accutally reflects what's been released. more about storybook:manual-deploy here