@defactor/ui-kit

Defactor UI Starter Kit

A frontend UI template for new projects to get started building on Defactor quickly while maintaining consistency in visual design and styles with other Defactor tools.

For more information on how to use the defactor UI Kit please refer to our developer documentation site or our NPM Package.

Installation

Basic knowledge about React and Storybook

Getting Started

Some things you need before getting started:

• git
• node.js
• yarn

Running for the First Time

• Clone this repo using git clone --depth=1 [e-mail]:defactor-com/ui-kit.git <YOUR_PROJECT_NAME>
• Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
• Run yarn to install all the dependencies

Quick Start

At this point you can execute yarn storybook to execute distribute action locally.

File Structure

We use the following technologies:

• React Library to create components
• Scss Allow improve styles by component
• Rollup API for fast compilation of code changes

Within the project repository you will find the following directories and files:

ui-kit/
├── public/ ..................... Public Source Assets
├── src/ ........................ Project Source Code
│   ├── components/ ............. Defactor Tools Components
│   ├── scss/ ................... Custom Styles per Component
│   ├── stories/ ................ Usage Examples per Component
├── .gitignore .................. Files Ignored by Git
├── CHANGELOG.md ................ Change Log
├── package.json ................ NPM Project Metadata
├── yarn.lock ................... Yarn Packages Lock File
├── LICENSE ..................... MIT License Terms
└── README.md ................... Project Documentation

Contributing

To contribute, please run yarn changeset to make a request to improve the version

Take this PR as an example of how to create components.

If the PR is approved, the next release package is automatically created.

Please report bugs big and small by opening an issue

About Defactor

As pioneers in the integration of Real-World Assets (RWA) with Decentralized Finance (DeFi), we're dedicated to unlocking liquidity and fostering innovation in the financial sector. Our platform is designed to streamline the adoption of DeFi solutions by businesses, underpinned by the real-world value of tokenized assets.

We're excited to see how you'll leverage Defactor to revolutionize the world of finance!

For more information on Defactor and our mission, visit our website.