Ubidy UI kit v1 BETA

// Because its still beta we should install ubidy_ui_kit by version only
npm install [email protected] --save

The UI Kit that powers Ubidy's internal projects built on ReactJS, Sass and Antdesign.

Visit the documentation

Standards and Guidelines

https://github.com/Ubidy/Ubidy_ReactStarterKit/wiki/Css-Style-Guide

Usage

We are using sass, simply import the scss file.

// compiled
@import "..path/node_modules/ubidy_ui_kit/css/main.scss"

//variables
@import "..path/ubidy_ui_kit/css/utils/variables"

//helpers
@import "..path/ubidy_ui_kit/css/utils/helpers"

or css

import "ubidy_ui_kit/css/main.css"

SET UP

-- autoprefixer : vscode -- install sass : link -- npm install

Development

To run develop ui kit

 npm start / yarn start

Test the component before publishing

npm run build:lib // for compiling react to es5

use the es5 component instead of es6 component.

To run docx // not yet integrated

npm run build
npm run docx

To build script:

 npm run build // for deployment in prod
 npm run build:style // build css
 npm run build:lib  // build lib

To publish in npm

V2

 git checkout master
 git pull origin master
 create a new branch release-VERSION
 npm run release
 
 https://github.com/Ubidy/Ubidy_UIKit/tags
 add release notes

To push in origin remote

 // first create a tags and push to origin remote tag
 git tag <version>
 git push origin --<tag or version>


 // second push in origin remote branch
 git push origin <task_branch>

Special thanks to our inspirations:

• Ant design
• Rico Sta. Cruz
• maintainablecss

Having an issue / problem / question?

please open an issue here

ubidy_ui_kit should never be used outside of officially endorsed Ubidy products or without explicit permission.