Brandwatch design system and React pattern library
This is the monorepo for Axiom packages.
| package | description | version |
|---|---|---|
| axiom-automation-testing | Provides IDs and selectors for targeting Axiom internal elements for Automation testing |  |
| axiom-charts | Provides Axiom charting and data visualisation React components |  |
| axiom-components | Provides core Axiom components for building Brandwatch UIs |  |
| axiom-composites | Provides Brandwatch contexutal components, comprising of Axiom components and materials. |  |
| axiom-documentation-loader | Webpack loader for extracting React component prop types and descriptions. |  |
| axiom-documentation-viewer | Provides React components for displaying, testing and viewing React components in configurable states. |  |
| axiom-formatting | Axiom resources for formatting dates and numbers |  |
| axiom-localization | Resources for helping out with localizations |  |
| axiom-materials | Low level resources, like colours and sizing variables to help build components |  |
| axiom-utils | Helpful javascript utilities |  |
| babel-plugin-axiom-imports | An Axiom specific babel plugin that transforms and removes unused Axiom exports. |  |
| babel-plugin-transform-svg-axiom | A babel plugin that recolours, optimises and inlines SVG files |  |
| eslint-config-axiom | eslint configurations used by Axiom and some other Brandwatch applications |  |
| stylelint-config-axiom | stylelint configurations used by Axiom and some other Brandwatch applications |  |
Axiom uses lerna and yarn workspaces to manage the various packages. To get up and running developing locally, you need the lerna cli. We're using the latest stable Node.js release.
yarn global add lerna
git clone git@github.com:BrandwatchLtd/axiom.git
cd axiom
lerna bootstrap
yarn start
Please checkout the CONTRIBUTING.md but basically we use the conventional commit format (google it) to handle automatic publishing, check tests and add them where appropriate and check linting.
Styleguide driven development is crucial. Most changes should be visble and replicable through the style guide and, where appropriate, through design review.