UI/UX Reusable component Library

This is the codebase for the UI/UX reusable component library

Design System

• Sparta

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Local Setup

A step by step series of examples that tell you how to get a development environment running Clone the repo from github and install dependencies through npm or yarn.

git clone https://[email protected]/vggdev/vgg-uiux-kit-react.git
cd vgg-uiux-kit-react
npm install
npm start

Branches

• master - Main Branch
• develop - Development branch

Contributing

1. Follow the local setup instructions above.
2. Initialize git flow with git flow init
3. Create your feature branch (git flow feature start feature/new_branch)
4. Commit your changes (git commit -m 'Add some new features')
5. Push to the remote branch (git push origin feature/new_branch)
6. Create a new Pull Request

Built With

• React - The front-end library used.
• Remix Icons - The Icon library used.
• create-react-app - The command line utility tool for setting up React project.

Developers

• UI/UX Team ([email protected])

Project Website

• Documentation Link

Unit Tests

• Testing library React Testing Library

Running Unit Tests

To run unit tests only use the command below

npm test

Generating Coverage Report

To generate coverage report for unit tests, use the command below

npm run coverage:local

Additional resources

• Proptypes
• classnames - A simple JavaScript utility for conditionally joining classNames together.
• Storybook
• Eslint
• Accessibility Guide
• Bootstrap
• Husky- Precommit hook

Usage

import {
  Button,
  Dropdown,
  Typography,
  Spacing,
  Tag,
  Table,
} from "vgg-ui-react";
import "vgg-ui-react/dist/styles/index.scss"