@winnie.ho.ama/ama-react-komponents v0.2.1
AMA React Components Library
This is a library of shared React components and its living storybook.
Included components:
- Accordion
- Button
Using this library
To include any component from this library in your React app, run this in terminal:
yarn add @winnie.ho.ama/ama-react-komponents
In your JS code, import component(s) with the following:
import { KomponentA, KomponentB } from '@winnie.ho.ama/ama-react-komponents';
Contribute to this library
Development of this library happens in the winnie.ho.ama organization for now. We will move the package under AMA umbrella when an official AMA account is set up at npmjs.com.
Talk to Dave or Winnie in blue team to be invited to winnie.ho.ama.
Run npm login and enter your npmjs.com credentials when prompted.
To avoid duplicate effort, please discuss with the Blue team before adding any new component. We might be able to update existing components to suit your needs.
Commit message format
We follow the Angular Commit Message Conventions.
There are several tools to help us enforce valid commit messages:
Publish updates to npm package
We are in the process of using semantic-release to automate package release workflow.
For now, please follow Semantic Versioning specification to version the package.
To publish a new package version, run yarn publish
Available Components
- Accordion
- Button
Available Scripts
yarn prepublishOnly
Transpiles code in the /src directory and outputs to /dist.
yarn test
Launches the test runner in the interactive watch mode. There's no test for now but they will be aded.
yarn storybook
Run Storybook locally at port 80 and view latest changes to the library visually. Work is being done to host the living Storybook on AWS Amplify.
yarn build-storybook <path to any existing folder>
Export current Storybook as a self-contained static web app in your folder of choice.
E.g. yarn build-storybook ../ama-storybook/0.1.0 will export current Storybook to the folder ama-storybook/0.1.0 outside of this project folder.