README.md 4.5 KB
Newer Older
A
Abdullah Almsaeed 已提交
1 2
Introduction
============
A
Abdullah Almsaeed 已提交
3

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

D
Dennis Neufeld 已提交
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.
A
almasaeed2010 已提交
10

A
Abdullah Almsaeed 已提交
11
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
A
Abdullah Almsaeed 已提交
12

A
Abdullah Almsaeed 已提交
13
Looking for Premium Templates?
A
Abdullah Almsaeed 已提交
14
------------------------------
A
Abdullah Almsaeed 已提交
15
**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.**
A
Abdullah Almsaeed 已提交
16

A
almasaeed2010 已提交
17

A
Abdullah Almsaeed 已提交
18
!["AdminLTE Presentation"] (https://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
A
almasaeed2010 已提交
19 20 21

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

A
Abdullah Almsaeed 已提交
22
Installation
A
Abdullah Almsaeed 已提交
23
------------
A
Abdullah Almsaeed 已提交
24 25
There are multiple ways to install AdminLTE.

A
Abdullah Almsaeed 已提交
26 27
####Download:

A
Typo  
Alberto Fernández 已提交
28
Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) and download the latest release.
A
Abdullah Almsaeed 已提交
29

A
Abdullah Almsaeed 已提交
30 31
####Using The Command Line:

A
Abdullah Almsaeed 已提交
32 33 34
**Github**

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
D
Dennis Neufeld 已提交
35
- Clone to your machine
A
Abdullah Almsaeed 已提交
36
```
A
Abdullah Almsaeed 已提交
37
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
A
Abdullah Almsaeed 已提交
38
```
A
Abdullah Almsaeed 已提交
39 40 41

**Bower**

A
Abdullah Almsaeed 已提交
42
```
A
Abdullah Almsaeed 已提交
43
bower install admin-lte
A
Abdullah Almsaeed 已提交
44
```
A
Abdullah Almsaeed 已提交
45

B
Bjørn Wikkeling 已提交
46 47 48 49 50 51
**npm**

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

A
Abdullah Almsaeed 已提交
52 53
**Composer**

A
Abdullah Almsaeed 已提交
54 55 56
```
composer require "almasaeed2010/adminlte=~2.0"
```
A
Abdullah Almsaeed 已提交
57 58

Documentation
A
Abdullah Almsaeed 已提交
59
-------------
A
Abdullah Almsaeed 已提交
60
Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
A
Abdullah Almsaeed 已提交
61 62 63
updated guide. Information will be added on a weekly basis.

Browser Support
A
Abdullah Almsaeed 已提交
64
---------------
A
almasaeed2010 已提交
65
- IE 9+
A
Abdullah Almsaeed 已提交
66 67 68 69 70 71
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)

Contribution
A
Abdullah Almsaeed 已提交
72
------------
A
Abdullah Almsaeed 已提交
73 74 75
Contribution are always **welcome and recommended**! Here is how:

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
A
Abdullah Almsaeed 已提交
76
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
A
Abdullah Almsaeed 已提交
77 78 79
- Make your changes
- Create a pull request

A
Abdullah Almsaeed 已提交
80 81
#### Contribution Requirements:

A
Abdullah Almsaeed 已提交
82 83 84 85 86 87
- 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
A
Abdullah Almsaeed 已提交
88
-------
A
Abdullah Almsaeed 已提交
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
A
Abdullah Almsaeed 已提交
90 91
reserves the right to change the license of future releases.

A
Abdullah Almsaeed 已提交
92 93
Todo List
---------
A
Updated  
Abdullah Almsaeed 已提交
94 95 96
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
A
Abdullah Almsaeed 已提交
97
- Right to left support
I
iae SAUDI 已提交
98
- ~~Custom pace style~~ (Done v2.3.1)
A
Abdullah Almsaeed 已提交
99

A
Abdullah Almsaeed 已提交
100
Legacy Releases
A
Abdullah Almsaeed 已提交
101
----------------
D
Dennis Neufeld 已提交
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.
A
Abdullah Almsaeed 已提交
103

A
Abdullah Almsaeed 已提交
104
Change log
A
Abdullah Almsaeed 已提交
105
----------
M
Morton Fox 已提交
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. 
A
almasaeed2010 已提交
107

A
Abdullah Almsaeed 已提交
108
Image Credits
A
Abdullah Almsaeed 已提交
109
-------------
A
Abdullah Almsaeed 已提交
110 111 112
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)

[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
A
almasaeed2010 已提交
113

A
Abdullah Almsaeed 已提交
114
[Pickaface](http://pickaface.net/)
A
almasaeed2010 已提交
115

A
Abdullah Almsaeed 已提交
116
[Unsplash](https://unsplash.com/)
A
almasaeed2010 已提交
117

A
Abdullah Almsaeed 已提交
118 119
[Uifaces](http://uifaces.com/)

A
Abdullah Almsaeed 已提交
120
Donations
A
Abdullah Almsaeed 已提交
121
---------
A
Abdullah Almsaeed 已提交
122
Donations are **greatly appreciated!**
A
almasaeed2010 已提交
123

A
Abdullah Almsaeed 已提交
124
[![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")