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.
AdminLTE/README.md

124 lines
4.4 KiB

10 years ago
Introduction
============
10 years ago
![Bower version](https://img.shields.io/bower/v/adminlte.svg)
[![npm version](https://img.shields.io/npm/v/admin-lte.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
9 years ago
**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.
11 years ago
10 years ago
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
10 years ago
Looking for Premium Templates?
10 years ago
------------------------------
10 years ago
**Almsaeed studio just opened a new premium templates page. Hand picked to insure the best quality and the most affordable prices. Visit https://almsaeedstudio.com/premium for more information.**
11 years ago
11 years ago
10 years ago
!["AdminLTE Presentation"] (https://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
11 years ago
**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.
10 years ago
Installation
10 years ago
------------
10 years ago
There are multiple ways to install AdminLTE.
10 years ago
####Download:
10 years ago
Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) and download the latest release.
10 years ago
10 years ago
####Using The Command Line:
10 years ago
**Github**
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
10 years ago
- Clone to your machine
```
10 years ago
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
10 years ago
**Bower**
```
10 years ago
bower install admin-lte
```
10 years ago
**npm**
```
npm install --save admin-lte
```
10 years ago
**Composer**
```
composer require "almasaeed2010/adminlte=~2.0"
```
10 years ago
Documentation
10 years ago
-------------
10 years ago
Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
10 years ago
updated guide. Information will be added on a weekly basis.
Browser Support
10 years ago
---------------
- IE 9+
10 years ago
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)
Contribution
10 years ago
------------
10 years ago
Contribution are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
10 years ago
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
10 years ago
- Make your changes
- Create a pull request
10 years ago
#### Contribution Requirements:
10 years ago
- 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
10 years ago
-------
10 years ago
AdminLTE is an open source project by [Almsaeed Studio](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
10 years ago
reserves the right to change the license of future releases.
10 years ago
Todo List
---------
10 years ago
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
10 years ago
- Right to left support
9 years ago
- ~~Custom pace style~~ (Done v2.3.1)
10 years ago
9 years ago
Legacy Releases
10 years ago
----------------
9 years ago
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.
10 years ago
10 years ago
Change log
10 years ago
----------
**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.
10 years ago
Image Credits
10 years ago
-------------
10 years ago
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
11 years ago
10 years ago
[Pickaface](http://pickaface.net/)
11 years ago
10 years ago
[Unsplash](https://unsplash.com/)
11 years ago
[Uifaces](http://uifaces.com/)
10 years ago
Donations
10 years ago
---------
10 years ago
Donations are **greatly appreciated!**
11 years ago
10 years ago
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "AdminLTE Presentation")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=629XCUSXBHCBC "Donate")