mechanical-wombat

React UI component lib

Usage in projects

Install

yarn add mechanical-wombat

Usage

import { MyComponent } from 'mechanical-wombat';

export const Example: React.FC = ({ children }) => <Button {...props}>{children}</Button>;

Hosted Storybook to find a list of currently available components

Default theme values

Development

Up and running

Prerequisites:

• Have NVM installed
• Be using the version of node outlined in .nvmrc. You can do this by running nvm use in the root of the project and following the instructions.
• Be using Yarn

Steps

• Checkout the repo and cd into it.
• Open your terminal of choice.
• Run yarn to install the dependencies.
• Open another terminal window/tab at the same location.
• In the first terminal run yarn start.
• In the second run yarn storybook this will open your browser at localhost port 9009.
• You are now ready to start developing reusable components.

Contributing

• All changes must be raised as a PR, and reviewed by the team
• PRs must contain an updated package.json version
• To add a new Icon, follow these steps before creating a PR

Publishing

Only ever release from the main branch, this means all code has been reviewed and approved. If you are unsure, don't release.

Steps

• Merge your PR into the main branch
• Tag and create a release in Github
• To publish, you will need access to NPM. If you don't have access, please speak to a member of the team
• In your terminal, run npm publish --dry-run to ensure there are no errors
• In your terminal, run npm publish
• Check that the version has been published here

You will need access to the NPM account attached