mirror of https://github.com/ColorlibHQ/AdminLTE
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
63 lines
3.6 KiB
63 lines
3.6 KiB
Introduction
|
|
============
|
|
|
|
[![Build Status](https://img.shields.io/travis/ColorlibHQ/AdminLTE/v2.svg)](https://travis-ci.org/ColorlibHQ/AdminLTE)
|
|
![Bower version](https://img.shields.io/bower/v/adminlte.svg)
|
|
[![npm version](https://img.shields.io/npm/v/admin-lte/v2-latest.svg)](https://www.npmjs.com/package/admin-lte)
|
|
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
|
|
[![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte)
|
|
|
|
**AdminLTE** -- is a fully responsive admin template. Based on **[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. Check out the live preview now and see for yourself.
|
|
|
|
**Preview on [AdminLTE.IO](https://adminlte.io/themes/v2.4.x/)**
|
|
|
|
### Looking for More Templates?
|
|
- **[Admin Templates](http://dashboardpack.com/)** by DashboardPack
|
|
- **[Bootstrap Templates](https://colorlib.com/wp/cat/bootstrap/)** by Colorlib
|
|
- **[Admin Dashboards](https://colorlib.com/wp/free-bootstrap-admin-dashboard-templates/)** by varios template designers and developers based on Bootstrap, Vue, React, Angular and more.
|
|
|
|
## Documentation & Installation Guide
|
|
Visit the [online documentation](https://adminlte.io/docs) for the most
|
|
updated guide.
|
|
|
|
!["AdminLTE Presentation"](https://adminlte.io/AdminLTE2.png "AdminLTE Presentation")
|
|
|
|
### 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/AdminLTE.git```
|
|
- Make your changes
|
|
- Create a pull request
|
|
|
|
#### Compile dist files
|
|
To compile the dist files you need nodejs/npm, clone/download the repo then:
|
|
|
|
1. `npm install` (install npm deps)
|
|
2. _Optional:_ `grunt watch` (developer mode, autocompile with browsersync support for live demo)
|
|
3. `grunt css` (compile css files)
|
|
4. `grunt js` (compile js files)
|
|
|
|
#### Contribution Requirements:
|
|
- When you contribute, you agree to give a non-exclusive license to AdminLTE.IO to use that contribution in any context as we (AdminLTE.IO) see appropriate.
|
|
- If you use content provided by another party, it must be appropriately licensed using an [open source](http://opensource.org/licenses) license.
|
|
- Contributions are only accepted through Github pull requests.
|
|
- Finally, contributed code must work in all supported browsers (see above for browser support).
|
|
|
|
### License
|
|
AdminLTE is an open source project by [AdminLTE.IO](https://adminlte.io) that is licensed under [MIT](http://opensource.org/licenses/MIT). AdminLTE.IO
|
|
reserves the right to change the license of future releases. Wondering what you can or can't do? View the [license guide](https://adminlte.io/docs/license).
|
|
|
|
### Legacy Releases
|
|
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://adminlte.io/themes/AdminLTE/documentation/index.html#upgrade), but if you intend to keep using AdminLTE 1.x, you can download the latest release from the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) section above.
|
|
|
|
### Change log
|
|
**For the most recent change log, visit the [releases page](https://github.com/ColorlibHQ/AdminLTE/releases).** We will add detailed release notes to each new release.
|
|
|
|
### Image Credits
|
|
- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
|
|
- [Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
|
|
- [Pickaface](http://pickaface.net/)
|
|
- [Unsplash](https://unsplash.com/)
|
|
- [Uifaces](http://uifaces.com/)
|