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.
124 lines
4.5 KiB
124 lines
4.5 KiB
Introduction
|
|
============
|
|
|
|
|
|
[](https://www.npmjs.com/package/admin-lte)
|
|
[](https://packagist.org/packages/almasaeed2010/adminlte)
|
|
[](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.
|
|
|
|
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
|
|
|
|
Looking for Premium Templates?
|
|
------------------------------
|
|
**Almsaeed studio just opened a new premium templates website. Hand picked to ensure the best quality and the most affordable prices. Visit https://themequarry.com for more information.**
|
|
|
|
|
|
|
|
**AdminLTE** has been carefully coded with clear comments in all of its JS, LESS and HTML files. LESS has been used to increase code customizability.
|
|
|
|
Installation
|
|
------------
|
|
There are multiple ways to install AdminLTE.
|
|
|
|
####Download:
|
|
|
|
Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) and download the latest release.
|
|
|
|
####Using The Command Line:
|
|
|
|
**Github**
|
|
|
|
- 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
|
|
```
|
|
|
|
**Bower**
|
|
|
|
```
|
|
bower install admin-lte
|
|
```
|
|
|
|
**npm**
|
|
|
|
```
|
|
npm install --save admin-lte
|
|
```
|
|
|
|
**Composer**
|
|
|
|
```
|
|
composer require "almasaeed2010/adminlte=~2.0"
|
|
```
|
|
|
|
Documentation
|
|
-------------
|
|
Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
|
|
updated guide. Information will be added on a weekly basis.
|
|
|
|
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](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
|
|
|
|
#### Contribution Requirements:
|
|
|
|
- When you contribute, you agree to give a non-exclusive license to Almsaeed Studio to use that contribution in any context as we (Almsaeed Studio) 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 [Almsaeed Studio](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
|
|
reserves the right to change the license of future releases.
|
|
|
|
Todo List
|
|
---------
|
|
- ~~Light sidebar colors~~ (Done v2.1.0)
|
|
- ~~Right sidebar~~ (Done v2.1.0)
|
|
- ~~Minified main-sidebar~~ (Done v2.1.0)
|
|
- Right to left support
|
|
- ~~Custom pace style~~ (Done v2.3.1)
|
|
|
|
Legacy Releases
|
|
----------------
|
|
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://almsaeedstudio.com/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/almasaeed2010/AdminLTE/releases) section above.
|
|
|
|
Change log
|
|
----------
|
|
**For the most recent change log, visit the [releases page](https://github.com/almasaeed2010/AdminLTE/releases) or the [changelog file](https://github.com/almasaeed2010/AdminLTE/blob/master/changelog.md).** We will add a 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/)
|
|
|
|
Donations
|
|
---------
|
|
Donations are **greatly appreciated!**
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=629XCUSXBHCBC "Donate")
|