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

A
almasaeed2010 已提交
4 5
**AdminLTE** -- is a fully responsive admin template. Based on **Bootstrap 3** 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
Abdullah Almsaeed 已提交
6
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
A
Abdullah Almsaeed 已提交
7

A
Abdullah Almsaeed 已提交
8
Looking for Premium Templates?
A
Abdullah Almsaeed 已提交
9
------------------------------
A
Abdullah Almsaeed 已提交
10
**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.**
A
Abdullah Almsaeed 已提交
11

A
almasaeed2010 已提交
12

A
Abdullah Almsaeed 已提交
13
!["AdminLTE Presentation"] (https://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
A
almasaeed2010 已提交
14 15 16

**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 已提交
17
Installation
A
Abdullah Almsaeed 已提交
18
------------
A
Abdullah Almsaeed 已提交
19 20
There are multiple ways to install AdminLTE.

A
Abdullah Almsaeed 已提交
21 22
####Download:

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

A
Abdullah Almsaeed 已提交
25 26
####Using The Command Line:

A
Abdullah Almsaeed 已提交
27 28 29
**Github**

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
A
Abdullah Almsaeed 已提交
30 31
- Clone to your machine 
```
A
Abdullah Almsaeed 已提交
32
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
A
Abdullah Almsaeed 已提交
33
```
A
Abdullah Almsaeed 已提交
34 35 36

**Bower**

A
Abdullah Almsaeed 已提交
37
```
A
Abdullah Almsaeed 已提交
38
bower install admin-lte
A
Abdullah Almsaeed 已提交
39
```
A
Abdullah Almsaeed 已提交
40 41 42

**Composer**

A
Abdullah Almsaeed 已提交
43 44 45
```
composer require "almasaeed2010/adminlte=~2.0"
```
A
Abdullah Almsaeed 已提交
46 47

Documentation
A
Abdullah Almsaeed 已提交
48
-------------
A
Abdullah Almsaeed 已提交
49
Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
A
Abdullah Almsaeed 已提交
50 51 52
updated guide. Information will be added on a weekly basis.

Browser Support
A
Abdullah Almsaeed 已提交
53
---------------
A
almasaeed2010 已提交
54
- IE 9+
A
Abdullah Almsaeed 已提交
55 56 57 58 59 60
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)

Contribution
A
Abdullah Almsaeed 已提交
61
------------
A
Abdullah Almsaeed 已提交
62 63 64
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 已提交
65
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
A
Abdullah Almsaeed 已提交
66 67 68
- Make your changes
- Create a pull request

A
Abdullah Almsaeed 已提交
69 70
#### Contribution Requirements:

A
Abdullah Almsaeed 已提交
71 72 73 74 75 76
- 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 已提交
77
-------
A
Abdullah Almsaeed 已提交
78
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 已提交
79 80
reserves the right to change the license of future releases.

A
Abdullah Almsaeed 已提交
81 82
Todo List
---------
A
Updated  
Abdullah Almsaeed 已提交
83 84 85
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
A
Abdullah Almsaeed 已提交
86 87 88
- Right to left support
- Custom pace style

A
Abdullah Almsaeed 已提交
89
Legacy Realeases
A
Abdullah Almsaeed 已提交
90
----------------
A
Abdullah Almsaeed 已提交
91
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#browsers), 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 已提交
92

A
Abdullah Almsaeed 已提交
93
Change log
A
Abdullah Almsaeed 已提交
94
----------
A
Abdullah Almsaeed 已提交
95
**v2.2.0**
A
Abdullah Almsaeed 已提交
96 97 98 99
- Bug fixes
- Added support for [Select2](https://select2.github.io/)
- Updated ChartJS

A
Abdullah Almsaeed 已提交
100 101 102 103 104 105 106
**v2.1.2:**
- Added explicit BoxWidget activation function issue #450
- Crushed some bugs

**v2.1.1:**
- Fix version error

107 108 109 110 111 112 113 114 115 116 117 118 119
**v2.1.0:**
- Update Ion Icons
- Added right sidebar ```.control-sidebar```
- Control sidebar has 2 open effects: slide over content and push content
- Control sidebar converts to always slide over content on small screens
- Added 6 new light sidebar skins
- Updated demo menu
- Added ChartJS preview page
- Fixed some minor bugs
- Added light control sidebar skin
- Added expand on hover option for sidebar mini
- Added fixed control sidebar layout

A
Abdullah Almsaeed 已提交
120 121 122
**v2.0.5:**
- Fixed issue #288

A
Abdullah Almsaeed 已提交
123 124
**v2.0.4:**
- Fixed bower.json to pick up newest release.
A
Abdullah Almsaeed 已提交
125

A
Abdullah Almsaeed 已提交
126 127 128 129 130 131
**v2.0.3**
- Bug fixes
- Fixed extra page when printing issue #264
- Updated documentation and fixed links scrolling issue
- Created print.less file (this makes it easier if you want to create a seperate CSS file for printing)
- Fixed sidebar stretching issue #275
A
Abdullah Almsaeed 已提交
132
- Fixed checkbox out of bounds issue in WYSIHTML5 editor.
A
Abdullah Almsaeed 已提交
133

A
Abdullah Almsaeed 已提交
134 135 136 137 138 139 140 141 142
**v2.0.2:**
- Solved issue with hidden arrow in select inputs.

**v2.0.1:**
- Updated README.md
- Fixed versioning issue in CSS, LESS, and JS
- Updated box-shadow for boxes
- Updated docs

A
Abdullah Almsaeed 已提交
143
**v2.0.0:**
A
Abdullah Almsaeed 已提交
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

- Major layout bug fixes
- Change in layout mark up
- Added transitions to the sidebar
- New skins and modified previous skins
- Change in color scheme to a more complementing scheme 
- Added footer support
- Removed pace.js from the main app.js
- Added support for collapsed sidebar as an initial state (add .sidebar-collapse to the body tag)
- Added boxed layout (.layout-boxed)
- Enhanced consistency in padding and margining
- Updated Bootstrap to 3.3.2 
- Fixed navbar dropdown menu on small screens positioning issues.
- Updated Ion Icons to 2.0.0
- Updated FontAwesome to 4.3.0
- Added ChartJS 1.0.1
- Removed iCheck dependency
- Created Dashboard 2.0
- Created new Chat widget (DirectChat)
- Added transitions to DirectChat
- Added contacts pane to DirectChat
- Changed .right-side to .content-wrapper
- Changed .navbar-right to .navbar-custom-menu
- Removed unused files
- Updated lockscreen style (HTML markup changed!)
- Updated Login & Registration pages (HTML markup changed!)
- Updated buttons style.
- Enhanced border-radius consistency
- Added mailbox: inbox, read, and compose pages
- Bootstrap & jQuery are now hosted locally
- Created documentation.

A
Abdullah Almsaeed 已提交
176
**ver 1.2.0:**
A
Abdullah Almsaeed 已提交
177

A
almasaeed2010 已提交
178 179 180 181
- Fixed the sidebar scroll issue when using the fixed layout.
- Added [Bootstrap Social Buttons](http://lipis.github.io/bootstrap-social/ "Bootstrap Social") plugin.
- Fixed RequireJS bug. Thanks to [StaticSphere](https://github.com/StaticSphere "github user"). 

A
Abdullah Almsaeed 已提交
182
**ver 1.1.0:**
A
Abdullah Almsaeed 已提交
183

A
almasaeed2010 已提交
184 185 186
- Added new skin. class: .skin-black
- Added [pace](http://github.hubspot.com/pace/docs/welcome/ "pace") plugin.

A
Abdullah Almsaeed 已提交
187
Image Credits
A
Abdullah Almsaeed 已提交
188
-------------
A
Abdullah Almsaeed 已提交
189 190 191
[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 已提交
192

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

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

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

A
Abdullah Almsaeed 已提交
199
Donations
A
Abdullah Almsaeed 已提交
200
---------
A
Abdullah Almsaeed 已提交
201
Donations are **greatly appreciated!**
A
almasaeed2010 已提交
202

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