Payabl.cc UI Library

Welcome to the Payabl.cc UI Library! This library is designed to provide a collection of reusable UI components and styles that can be used by merchants and developers to create consistent and visually appealing user interfaces for their applications.

Getting Started

Before you can start using the Payabl.cc UI Library, make sure you have the following prerequisites installed:

• Node.js (version 12 or higher)
• Yarn package manager

Cloning the Repository

To clone the Payabl.cc UI Library repository, use the following command:

git clone [email protected]:payabl-cc/payabl-ui-library.git

Running Tests

The Payabl.cc UI Library comes with a comprehensive test suite to ensure the quality and stability of its components. To run the tests, follow these steps:

1. Navigate to the root directory of the cloned repository.
2. Install the dependencies by running the following command:

yarn install

3. Once the dependencies are installed, you can execute the test suite by running the following command:

yarn test

This will run all the tests and display the results in the console.

Running Storybook

Storybook is a development environment for UI components that allows you to browse and interact with different components in isolation. To run Storybook for the Payabl.cc UI Library, follow these steps:

1. Navigate to the root directory of the cloned repository.
2. Install the dependencies if you haven't done so already by running:

yarn install

3. Start Storybook by running the following command:

yarn storybook

This will launch Storybook in your default web browser and display a list of available components.

Usage

To use the components and styles provided by the Payabl.cc UI Library in your project, you can follow these steps:

1. Install the library as a dependency in your project using the package manager of your choice. For example, with Yarn:

yarn add payabl-ui-library

2. Import the desired components or styles from the library into your project:

import { PaymentButton } from 'payabl-ui-library';

You can then use these components and styles in your application.

License

The Payabl.cc UI Library is released under the MIT License. Please review the license file for more details.