Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cocaptain Update README.md #96

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Cocaptain Update README.md #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
**CoPilot** is a fully responsive admin template that is forked from [AdminLTE](https://almsaeedstudio.com). The difference here is that this repo is tailored to use with [Vue.js](https://vuejs.org). The UI is based on the [Bootstrap 3](https://github.com/twbs/bootstrap) framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
**Cocaptain** is a fully responsive admin template that is forked from [AdminLTE](https://almsaeedstudio.com). The difference here is that this repo is tailored to use with [Vue.js](https://vuejs.org). The UI is based on the [Bootstrap 3](https://github.com/twbs/bootstrap) framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.

<a href="https://copilot.misterGF.io" target="_blank">✈️️ Take it for a spin.</a>
<a href="https://Cocaptain.misterGF.io" target="_blank">✈️️ Take it for a spin.</a>


[![Build Status](https://travis-ci.org/misterGF/CoPilot.svg?branch=master)](https://travis-ci.org/misterGF/CoPilot)
[![Build status](https://ci.appveyor.com/api/projects/status/wenct56narbt6r1l?svg=true)](https://ci.appveyor.com/project/misterGF/copilot)
[![Build Status](https://travis-ci.org/misterGF/Cocaptain.svg?branch=master)](https://travis-ci.org/misterGF/Cocaptain)
[![Build status](https://ci.appveyor.com/api/projects/status/wenct56narbt6r1l?svg=true)](https://ci.appveyor.com/project/misterGF/Cocaptain)

!["CoPilot Screenshot"](http://res.cloudinary.com/gatec21/image/upload/v1489954238/copilot-march-2017_ifdrlj.png)
!["Cocaptain Screenshot"](http://res.cloudinary.com/gatec21/image/upload/v1489954238/cocaptain-march-2017_ifdrlj.png)

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](https://github.com/vuejs/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.
The structure of the app is scaffolded by [vue-cli](https://github.com/vuejs/vue-cli). Which is a simple CLI tool that setups our environment. Cocaptain 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](https://github.com/misterGF/CoPilot/tree/vue1.0_version).
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](https://github.com/misterGF/Cocaptain/tree/vue1.0_version).

I also recommend that you install vue-devtools for Chrome so that you can easily inspect that state of vue.
![vue-devtools](http://res.cloudinary.com/gatec21/image/upload/v1461611064/copilot-vuetools_t1mvpg.png)
![vue-devtools](http://res.cloudinary.com/gatec21/image/upload/v1461611064/cocaptain-vuetools_t1mvpg.png)

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.
Installing Cocaptain is easy.

#### Download:

Expand All @@ -30,7 +30,7 @@ Download from Github
#### Using The Command Line:

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


Expand Down Expand Up @@ -71,7 +71,7 @@ Depending on the component you are working on you should have the following link
- Vue-Router - [online documentation](https://github.com/vuejs/vue-router)
- Vuex - [online documentation](https://github.com/vuejs/vuex)

Information and tips about CoPilot can be found in the [wiki](https://github.com/misterGF/CoPilot/wiki).
Information and tips about Cocaptain be found in the [wiki](https://github.com/misterGF/Cocaptain/wiki).

Browser Support
---------------
Expand All @@ -86,7 +86,7 @@ Contribution
Contribution are always **welcome and recommended**! Here is how:

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/CoPilot.git```
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/Cocaptain.git```
- Make your changes
- Create a pull request

Expand All @@ -96,7 +96,7 @@ The purpose of this project is to provide a full example of how to leverage Vue.

License
-------
CoPilot is an open source project by [Gil Ferreira](http://gferreira.me) that is licensed under [MIT](http://opensource.org/licenses/MIT).
Cocaptain is an open source project by [Gil Ferreira](http://gferreira.me) that is licensed under [MIT](http://opensource.org/licenses/MIT).

Image Credits
-------------
Expand Down