Hexagon

Component library for digital products of Beequip.

Getting started

Installing

Install with yarn.

yarn add @beequip/hexagon

Or npm.

npm install @beequip/hexagon

Setting up the provider

Hexagon requires a theme and the ThemeProvider from styled-components to work correctly. Import them both and wrap your application component:

import { theme } from '@beequip/hexagon'
import { ThemeProvider } from 'styled-components'

function Index() {
    return (
        <ThemeProvider theme={theme}>
           <App />
        </ThemeProvider>
    )
}

Testing

For development, this package can be linked into another project. This is useful to test out new features or when trying to debug an issue in Hexagon that manifests itself in another project.

Follow the instructions of yarn link or npm link

Storybook

All components in Hexagon can be previewed in our Storybook. Simply run yarn storybook to start the Storybook in your development environment.

We use Chromatic to publish and review our Storybook. The CI is configured to automatically publish the Storybook and run Chromatic’s automation whenever you push code.

• Library at Chromatic
• Latest published Storybook

Publishing

• Make sure everything is merged in develop (check for linting errors)
• Merge develop into master
• Run yarn release (you have to be a member of the organization and logged in with npm login or yarn login)

Contributing

Please see our contributing.md.