@aukindustries/auk-components v0.1.0

Auk Base Components

Installation

Node version: 10.16.3

yarn

Development

• Make sure you finish the installation properly first

yarn run storybook

• To ensure your component works as expectation, Please use this below url in Incognito mode for chrome or Private mode for safari

http://localhost:9009

Test

yarn test

Build Component

yarn run build:components

Build Storybook

yarn run build-storybook

Coding Style

• Prettier and es-lint are using to check Typescript code for readability, maintainability, and functionality errors

• Please follow this style, and do not force commit to bypass the coding style validation

Precommit

• Coding style validation and Component testing will be called as soon as you commit anything

File structure convention

Example for button component

1.  Button.stories.mdx
2.  Button.style.tsx
3.  Button.test.tsx
4.  Button.tsx
5.  Button.type.tsx
6.  index.ts

Contribution

• Pull it

• Create your branch from develop branch (git checkout -b feature/your_branch_name)

• Commit your changes (git commit -am 'Add some amazing codes')

• Push to the branch (git push origin feature/your_branch_name)

• Create a new pull request to merge into develop branch