Skip to content

Latest commit

 

History

History
134 lines (97 loc) · 3.83 KB

README.md

File metadata and controls

134 lines (97 loc) · 3.83 KB
Raw

Vesan

Vesan is a User Interface Framework made with Vue & Animadio

NPM Version GitHub Top Language Code Size

NPM Downloads GitHub Last Commit

Codacy Badge Maintainability

Download

Use this Template
or
git clone https://github.com/philippebeck/vesan.git
or
Latest Release

Package

NPM : npm i vesan
or
Yarn : yarn add vesan

If you choose to get Vesan from NPM or Yarn : you need to copy Vesan from node_modules/vesan to the root of your App

Installation

Install the frontend dependencies :
$ npm install

Configuration

To configure the frontend constants, replace values :
/src/config/values.example.js (then rename it /src/config/values.js)

Usage

To run the UI :
$ npm start

Production

  1. Compile the frontend :
    $ npm run build

  2. Then use the files of the dist folder for your prod UI

Content

Elements Components :

  • BtnElt (Link & Button Elements)
  • CardElt (Article & Section Elements)
  • FieldElt (User Input & User Select Elements)
  • FootElt (Footer Element)
  • ListElt (List Element)
  • MediaElt (Audio, Image, Quote & Video Elements)
  • NavElt (Navbar & Sidebar Elements)
  • SliderElt (Slider Element)
  • TableElt (Table Element)

Setters Components :

  • ArticleSet (Article Setter)
  • GallerySet (Gallery Setter)
  • ImageSet (Image Setter)
  • LinkSet (Link Setter)
  • OrderSet (Order Setter)
  • ProductSet (Product Setter)
  • ProjectSet (Project Setter)
  • UserSet (User Setter)

Main Views :

  • HomeView (Home)
  • ContactView (Contact)
  • LegalView (Legal notice)
  • LoginView (Sign in, Sign up, Forgot password)
  • ProfileView (User profile)
  • ErrorView (Error)

Data Views :

  • BlogView (Blog with articles list)
  • ArticleView (Article of the blog)
  • PortfolioView (Portfolio of projects)
  • ShopView (Shop with products list)
  • ProductView (Product of the shop)
  • BasketView (Basket & order process)
  • GalleryView (Galleries list)
  • ImageView (Images of a gallery)
  • LinkView (Links list)

Services :

  • Checkers : checkRange(), checkRegex(), checkRole()
  • Fetchers : getData(), postData(), putData(), deleteData()
  • Getters : getCats(), getItemName(), getItemsByCat()
  • Setters : setError(), setGlobalMeta(), setMeta()

Documentation

Available Demo :

Available Readme :