Frontend Kit

Reusable components, utils for various projects @ ZebraX

Prerequisites

• Yarn v1.x.x

Install NPM Package

Run this command to install this package with its peer dependencies

yarn add @zebraxid/frontend-kit cross-fetch

Quick Start

Locally

git clone https://github.com/zebraxid/frontend-kit.git
cd frontend-kit
yarn install
yarn storybook

To Do

• Modify all charts to pass tooltip and axis format as props

Contributing

1. There's several rules on adding new functions or new components to this modules:

   a. If you're creating new function on src/styles or src/utils, please make sure that the function name is unique to prevent the error when the function is being exported.

   b. If you're creating new React component, don't forget to register your new component to components entrypoint on src/components/index.js and make sure the export name is the same as the component name to make it easier to import.

2. Always run yarn build after finished adding the new functions or components to compile the modules. Without running this command, your new functions or components will not be exported.

3. When creating a pull request, please review CHANGELOG.md and add future version. Also update version in package.json.

4. After pull request is merged to develop and master branch, check the latest tag

   git tag

5. Add tag following the rules [MAJOR].[MINOR].[PATCH]

   git tag <tag>
   git push origin <tag>