UI kit POC

This is a POC for creating a custom UI kit which will be used in our applications. From this one, we will bootstrap all others repositories.

How to boostrap new repo from this one?

• Create a new repo and set this one as a template
• Update name and all urls in package.json
• Setup CircleCI project with existing config.yml
• Add NPM_TOKEN and GH_TOKEN to CircleCi environment variables

Available Scripts

In the project directory, you can run:

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the dist folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

Your library is ready to be deployed!

yarn storybook

It will run Storybook on localhost:6006

We are using Storybook to check and test changes we made. Be sure that you add stories for every component you develop.

yarn commit

To have beautiful commit messages, we are using Commitizen. If you do yarn commit, check your CLI and follow the steps.

Deploy new version

For the CI/CD purposes, we are using CircleCI. You can check CircleCi config file.

On every commit on the main branch which is following semantic release commit message rules, new version will be released.

Check the rules for commit messages -> Semantic release commit message rules

Use components

If you want to import component in your project

import {Button, Input} from "issuix-ui-kit-poc";

Use styles

If you want to import styles in your project, just import it in the index.css

@import url('issuix-ui-kit-poc/dist/cjs/bundle.css');