Skip to content

haycco/avui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AVUI

Project based on Vue.js 2.x, AdminLTE, Bootstrap 3.x

Sauce Test Status

avui is a fully responsive admin template that is forked from AdminLTE. The difference here is that this repo is tailored to use with vue.js 2.x. The UI is based on the Bootstrap 3 framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. AdminLTE Presentation

In an attempt to keep the project clean I have not included every plugin/feature that AdminLTE offers. You simply need to add the plugin in the /static/plugins folder to include them or use npm. I've included the popular ones.

The structure of the app is scaffolded by vue-cli. Which is a simple CLI tool that setups our environment. AVUI uses the webpack package. So we get a full-featured Webpack + vue-loader setup with hot reload, linting, testing & css extraction.

We leverage all the goodies that vue.js offers. Vue-Router for routing. Vue-Resource for AJAX calls. Vuex for state management. This project is using VueJS 2.0!.

I also recommend that you install vue-devtools for Chrome so that you can easily inspect that state of vue. vue-devtools

The data that is being pulled uses faker.js to make it dynamic. This is for demo purposes. Look for demo.* for information that is generated dynamically.

Installation

Installing avui is easy.

Download:

Download from Github

Using The Command Line:

git clone https://github.com/haycco/avui.git

Build Setup

# install dependencies
sudo npm install

# serve with hot reload at localhost:9090
npm run dev

# build for production with minification
npm run build

# run all tests
npm test

For detailed explanation on how things work, checkout the guide and docs for vue-loader.

Documentation

Depending on the component you are working on you should have the following links handy.

Information and tips about AVUI can be found in the wiki.

Contribution

Contribution are always welcome and recommended! Here is how:

  • Fork the repository (here is the guide).
  • Clone to your machine git clone https://github.com/YOUR_USERNAME/avui.git
  • Make your changes
  • Create a pull request

TODOS

The purpose of this project is to provide a full example of how to leverage Vue. If you find anything that can be Vue-ified please send me a PR.

License

AVUI is an open source project by licensed under MIT.

About

Vue.js 2.x with AdminLTE UI Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published