README.md 4.53 KB
Newer Older
Nicolas Widart's avatar
Nicolas Widart committed
1 2 3
Introduction
============

4 5 6 7 8
![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)
[![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte)

9
**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.
Nicolas Widart's avatar
Nicolas Widart committed
10

11
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
Nicolas Widart's avatar
Nicolas Widart committed
12 13 14

Looking for Premium Templates?
------------------------------
15
**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.**
Nicolas Widart's avatar
Nicolas Widart committed
16 17


18
!["AdminLTE Presentation"] (https://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
Nicolas Widart's avatar
Nicolas Widart committed
19 20 21 22 23 24 25 26 27

**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:

28
Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) and download the latest release.
Nicolas Widart's avatar
Nicolas Widart committed
29 30 31 32 33 34

####Using The Command Line:

**Github**

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
35
- Clone to your machine
Nicolas Widart's avatar
Nicolas Widart committed
36 37 38 39 40 41 42 43 44 45
```
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```

**Bower**

```
bower install admin-lte
```

46 47 48 49 50 51
**npm**

```
npm install --save admin-lte
```

Nicolas Widart's avatar
Nicolas Widart committed
52 53 54 55 56 57 58 59
**Composer**

```
composer require "almasaeed2010/adminlte=~2.0"
```

Documentation
-------------
60
Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
Nicolas Widart's avatar
Nicolas Widart committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
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
-------
89
AdminLTE is an open source project by [Almsaeed Studio](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
Nicolas Widart's avatar
Nicolas Widart committed
90 91 92 93
reserves the right to change the license of future releases.

Todo List
---------
94 95 96
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
Nicolas Widart's avatar
Nicolas Widart committed
97
- Right to left support
98
- ~~Custom pace style~~ (Done v2.3.1)
Nicolas Widart's avatar
Nicolas Widart committed
99

100
Legacy Releases
Nicolas Widart's avatar
Nicolas Widart committed
101
----------------
102
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.
Nicolas Widart's avatar
Nicolas Widart committed
103 104 105

Change log
----------
106
**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. 
Nicolas Widart's avatar
Nicolas Widart committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

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!**

[![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")