Saviway UI toolkit

Getting started

this toolkit developed with Vuejs3 + Typescript and build by Vite.

If you are building Custom Web Applications, be sure to use our UI-toolkit.

Install

Use the node package manager npm or yarn to install.

npm install 
'#or'
yarn install

Quick Start

import Vue from 'vue';
import { SButton } from "@saviway/ui";
import App from './App.vue';

Vue.use(SButton)

new Vue({
  el: '#app',
  render: h => h(App)
});

Documentation

documentation based on docsify for markdown and vue-docgen-cli for serve docs.

npm run docs:generate 
'#or'
yarn docs:generate

then build package library with

npm run build 
'#or'
yarn build

for serve in localhost

npm run docs:serve 
'#or'
yarn docs:serve

now check http://localhost:3000/ if port:3000 reserved so check new port on your terminal

if you want generate only markdowns run this command : npm run docs:generate

for build mode

npm run docs:build 
'#or'
yarn docs:build

now check /docdist in root directory

Playground

if you want test code and see changes

npm run play
'#or'
yarn play

now check http://localhost:3000/ if port:3000 reserved so check new port on your terminal

Build

npm run build 
'#or'
yarn build

License

MIT