UIK Framework
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
npm init
type this in your project assets folder, it will crete a package.json file
"dependencies": {
"uik-framework": "^0.3.4"
},
Add the dependencies in your project folder
Then Run
yarn install
Install Package
npm install uik-framework --save
Install Global Dependencies
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
/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
<!-- jQuery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<!-- UIK Framework-->
<link rel="stylesheet" type="text/css" href="dist/uik.bundle.min.css">
<script src="dist/uik.bundle.min.js"></script>
OR
"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