October 19, 2017

Copilot Admin

Version      Author

Description

CoPilot 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. 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. ✈️ Take it for a spin.

"CoPilot Screenshot"

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/js/plugin 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. CoPilot 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! Earlier versions can be found under the vue 1.0 branch. 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 CoPilot is easy.

Download:

Download from Github

Using The Command Line:

git clone https://github.com/misterGF/CoPilot.git

Build Setup

``` bash sudo npm install

serve with hot reload at localhost:8080

npm run dev

build for production with minification

npm run build

run unit tests

npm run unit

run e2e tests

npm run e2e

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 CoPilot can be found in the wiki.

Browser Support

  • IE 9+
  • Firefox (latest)
  • Chrome (latest)
  • Safari (latest)
  • Opera (latest)

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/CoPilot.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

CoPilot is an open source project by Gil Ferreira that is licensed under MIT.

Image Credits

Pixeden Graphicsfuel Pickaface Unsplash Uifaces
CoPilot 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. 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. ✈️ Take it for a spin. 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...