uik-framework

UIK Framework

[![Keep a Changelog v0.3.4 badge][changelog-badge]][changelog]
[![Version 0.3.4 Badge][version-badge]][changelog]
[![MIT License Badge][license-badge]][license]

Follow Step by Step Integration Below

* Install
* Install Package
* Global Dependencies
* Modifications
* Build / Compile
* View Compiled Files
* Include Files in your project
* Slack Support
* Documentation / Demo

Install

``render
npm init
`
type this in your project assets folder, it will crete a package.json file

`render
"dependencies": {
"uik-framework": "^0.3.4"
},
`
Add the dependencies in your project folder

Then Run
`render
yarn install
`

Install Package

`render
npm install uik-framework --save
`

Install Global Dependencies

`render
npm install -g webpack
npm install -g webpack-cli
npm install -g browserify (Browserify)
npm install -g uglify-js (Uglify JS)
npm install -g uglifycss (Uglify Css)
`

Modifications

You can modify which files you want to keep in the dist.
Files can be found in /lib folder.

Build / Compile

Either directly use scss as reuqired

OR

Run this command for CSS & JS compilation


`render
/uik-framework> webpack --config webpack.config.js
`

View Compiled Files

All files will be added in /dist folder

Include Files in your project

Copy and Paste /lib from package inside your project

Add them in your SCSS Production

OR

Add them in our HTML Document

`render






`
OR
`render
"styles": [
"../node_modules/uik-framework/src/dist/css/uik.bundle.min.css"
],
"scripts": [
"../node_modules/uik-framework/src/dist/js/uik.bundle.min.js"
],
``

Slack Support

Free to join my slack #uik-framework

Documentation / Demo

uik-framework.com


[changelog]: ./CHANGELOG.md
[changelog-badge]: https://img.shields.io/badge/changelog-v0.3.4-%23E05735
[license]: ./LICENSE.md
[version-badge]: https://img.shields.io/badge/version-0.3.4-blue.svg
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg