docs: update readme
This commit is contained in:
Łukasz Holeczek
@@ -1,34 +1,165 @@
|
||||
# @coreui/coreui-free-vue-admin-template
|
||||
[](https://github.com/coreui/coreui)
|
||||
[![npm package][npm-coreui-badge]][npm-coreui]
|
||||
[![NPM downloads][npm-coreui-download]][npm-coreui]
|
||||
[](https://github.com/coreui/vue)
|
||||
[![npm package][npm-coreui-vue-badge]][npm-coreui-vue]
|
||||
[![NPM downloads][npm-coreui-vue-download]][npm-coreui-vue]
|
||||
[![npm next][npm-next]][npm]
|
||||
|
||||
## Project setup
|
||||
```
|
||||
yarn install
|
||||
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
|
||||
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
|
||||
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
|
||||
[npm-coreui-vue]: https://www.npmjs.com/package/@coreui/vue
|
||||
[npm-coreui-vue-badge]: https://img.shields.io/npm/v/@coreui/vue.png?style=flat-square
|
||||
[npm-coreui-vue-download]: https://img.shields.io/npm/dm/@coreui/vue.svg?style=flat-square
|
||||
[npm-next]: https://img.shields.io/npm/v/@coreui/vue/next.png?style=flat-square
|
||||
[npm]: https://www.npmjs.com/package/@coreui/vue
|
||||
|
||||
# CoreUI Free Vue Admin Template v4
|
||||
|
||||
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Versions](#versions)
|
||||
* [CoreUI Pro](#coreui-pro)
|
||||
* [Quick Start](#quick-start)
|
||||
* [Installation](#installation)
|
||||
* [Basic usage](#basic-usage)
|
||||
* [What's included](#whats-included)
|
||||
* [Documentation](#documentation)
|
||||
* [Versioning](#versioning)
|
||||
* [Creators](#creators)
|
||||
* [Community](#community)
|
||||
* [Copyright and License](#copyright-and-license)
|
||||
|
||||
## Versions
|
||||
|
||||
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
|
||||
* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
|
||||
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
|
||||
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
|
||||
|
||||
## CoreUI Pro
|
||||
|
||||
**Only customers with [Enterpise Membership Plan](https://coreui.io/pro/#buy) have access to private github CoreUI Pro repository.**
|
||||
|
||||
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
|
||||
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular)
|
||||
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
|
||||
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
|
||||
|
||||
## Quick Start
|
||||
|
||||
- [Download the latest release](https://github.com/coreui/coreui-free-vue-admin-template/archive/refs/heads/v4.zip)
|
||||
- Clone the repo: `git clone https://github.com/coreui/coreui-free-vue-admin-template.git`
|
||||
|
||||
### Instalation
|
||||
|
||||
``` bash
|
||||
$ npm install
|
||||
```
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
```
|
||||
yarn serve
|
||||
or
|
||||
|
||||
``` bash
|
||||
$ yarn install
|
||||
```
|
||||
|
||||
### Compiles and minifies for production
|
||||
```
|
||||
yarn build
|
||||
### Basic usage
|
||||
|
||||
``` bash
|
||||
# dev server with hot reload at http://localhost:3000
|
||||
$ npm serve
|
||||
```
|
||||
|
||||
### Run your unit tests
|
||||
```
|
||||
yarn test:unit
|
||||
or
|
||||
|
||||
``` bash
|
||||
# dev server with hot reload at http://localhost:3000
|
||||
$ yarn serve
|
||||
```
|
||||
|
||||
### Run your end-to-end tests
|
||||
```
|
||||
yarn test:e2e
|
||||
Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files.
|
||||
|
||||
#### Build
|
||||
|
||||
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
|
||||
|
||||
```bash
|
||||
# build for production with minification
|
||||
$ npm run build
|
||||
```
|
||||
|
||||
### Lints and fixes files
|
||||
```
|
||||
yarn lint
|
||||
or
|
||||
|
||||
```bash
|
||||
# build for production with minification
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
### Customize configuration
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).
|
||||
## What's included
|
||||
|
||||
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
|
||||
|
||||
```
|
||||
coreui-free-vue-admin-template
|
||||
├── public/ # static files
|
||||
│ └── index.html # html template
|
||||
│
|
||||
├── src/ # project root
|
||||
│ ├── assets/ # images, icons, etc.
|
||||
│ ├── components/ # common components - header, footer, sidebar, etc.
|
||||
│ ├── layouts/ # layout containers
|
||||
│ ├── scss/ # scss styles
|
||||
│ ├── router # routes config
|
||||
│ └── store # template state example
|
||||
│ ├── views/ # application views
|
||||
│ ├── _nav.js # sidebar navigation config
|
||||
│ ├── App.vue
|
||||
│ ├── ...
|
||||
│ └── main.js
|
||||
│
|
||||
└── package.json
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Vue](https://coreui.io/vue/)
|
||||
|
||||
## Versioning
|
||||
|
||||
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
|
||||
|
||||
See [the Releases section of our project](https://github.com/coreui/coreui-free-vue-admin-template/releases) for changelogs for each release version.
|
||||
|
||||
## Creators
|
||||
|
||||
**Łukasz Holeczek**
|
||||
* <https://twitter.com/lukaszholeczek>
|
||||
* <https://github.com/mrholek>
|
||||
* <https://github.com/coreui>
|
||||
|
||||
**CoreUI team**
|
||||
* https://github.com/orgs/coreui/people
|
||||
|
||||
## Community
|
||||
|
||||
Get updates on CoreUI's development and chat with the project maintainers and community members.
|
||||
|
||||
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
|
||||
- Read and subscribe to [CoreUI Blog](https://blog.coreui.ui/).
|
||||
|
||||
## Copyright and License
|
||||
|
||||
copyright 2021 creativeLabs Łukasz Holeczek.
|
||||
|
||||
|
||||
Code released under [the MIT license](https://github.com/coreui/coreui-free-vue-admin-template/blob/master/LICENSE).
|
||||
There is only one limitation you can't can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In past we faced some problems with persons who tried to sell CoreUI based templates.
|
||||
|
||||
## Support CoreUI Development
|
||||
|
||||
CoreUI is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying [CoreUI Pro Version](https://coreui.io/pro/).
|
||||
|
||||
We're also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on [Twitter](https://twitter.com/lukaszholeczek).
|
||||
|
||||
Reference in New Issue
Block a user