@winnie.ho.ama/ama-react-components NPM

Build Status

AMA React Components Library

This is a library of shared React components and its living storybook.

Available Components

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-components

In App.js, wrap your app with ThemeProvider like this:

import { ThemeProvider } from 'styled-components'
import { Theme } from '@winnie.ho.ama/ama-react-components/dist/styles'

function App() {
  return (
    <ThemeProvider theme={Theme}>
      <div className="App">
      ...
      </div>
    </ThemeProvider>
  )
}

To use a component, do this:

import { Button } from '@winnie.ho.ama/ama-react-components'

render() {
  return (
    <Button/>
  )
}

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 by using commitizen.

Commit changes using `commitizen`

This repo is commitizen friendly!

Instead of using git commit, use yarn commit and follow the prompts.

Publish updates to npm package

We use semantic-release to automate package release workflow.

Whenever a PR is created, updated or re-opened, semantic-release is dry-run and you can see its commit analysis and preview the package version in the CodeBuild log.

When changes are pushed to the master branch, semantic-release is run again and it will publish a new version of this package to npm (same version as previewed in dry runs).