Ubidy UI Kit

Ubidy UI Kit is a comprehensive collection of reusable user interface components and design elements that can be used to build modern and visually appealing web applications.

Table of Contents

• Introduction
• Requirements
• Installation
• Contribution

Introduction

Ubidy UI Kit is designed to simplify the process of building user interfaces by providing a set of pre-built components and styles. It aims to improve consistency and efficiency in UI development and enhance the overall user experience of your web applications.

Requirements

To use Ubidy UI Kit, you will need the following:

• Node.js 10: Install Node.js from the official website: Node.js

• Node Version Manager (nvm): If you need to manage multiple versions of Node.js, you can install nvm. Instructions for installation can be found at: nvm GitHub repository

• Yarn: Yarn is a popular package manager used in JavaScript projects. Install Yarn by following the instructions on the official website: Yarn

• Visual Studio Code: Ubidy UI Kit is compatible with Visual Studio Code, a popular code editor. You can download Visual Studio Code from the official website: Visual Studio Code

Installation

To install Ubidy UI Kit, follow these steps:

1. Clone the Ubidy UI Kit repository from GitHub: git clone https://github.com/your-username/ubidy-ui-kit.git

2. Navigate to the project directory: cd ubidy-ui-kit

3. Install project dependencies using Yarn: yarn install

That's it! You're now ready to start using Ubidy UI Kit in your web application.

Contribution

Step 1

Made changes then push to a feature branch, once approved, merge it to master branch

Step 2

Create a PR using release-v*.*.* branch, once approved, merge it to master branch

Step 3

Build the package yarn run build

Step 4

Publish yarn publish

Step 5

Create a release using semantic version

Local Testing

Step 1

Build using npm run build or yarn run build

Step 2

Create a tarball using npm pack or yarn pack output example: ubidy_devs-ubidy-uikit-0.5.142

Step 3

Get the tarball filepath e.g. C:\\Users\\USER\\Documents\\Repository\\Github\\Ubidy\\Ubidy_UIKitTS (@ubidy_devs)\\ubidy_devs-ubidy-uikit-v0.5.142.tgz and install it in your FE Webapp

In AgencyWebApp use npm install or yarn install + the filepath of your tarball npm install C:\\Users\\USER\\Documents\\Repository\\Github\\Ubidy\\Ubidy_UIKitTS (@ubidy_devs)\\ubidy_devs-ubidy-uikit-v0.5.142.tgz