README.md 4.9 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](http://almsaeedstudio.com)**
A
Abdullah Almsaeed 已提交
7

A
Abdullah Almsaeed 已提交
8 9
Looking for Premium Templates?
==============================
A
Abdullah Almsaeed 已提交
10 11
**Almsaeed studio just opened a new premium templates page. Hand picked to insure the best quality and the most affordable prices. Visit http://almsaeedstudio.com/premium for more information.**

A
almasaeed2010 已提交
12

A
Abdullah Almsaeed 已提交
13
!["AdminLTE Presentation"] (http://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 18 19 20 21 22 23 24 25 26 27 28 29
Installation
============
There are multiple ways to install AdminLTE.

Download:
---------
Download from Github or [visit Almsaeed Studio](http://almsaeedstudio.com) and download the lateset release.

Using The Command Line:
-----------------------
**Github**

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

**Bower**

A
Abdullah Almsaeed 已提交
37 38 39
```
bower install git://github.com/almasaeed2010/AdminLTE.git
```
A
Abdullah Almsaeed 已提交
40 41 42

**Composer**

A
Abdullah Almsaeed 已提交
43 44 45
```
composer require "almasaeed2010/adminlte=~2.0"
```
A
Abdullah Almsaeed 已提交
46 47 48 49 50 51 52 53

Documentation
=============
Visit the [online documentation](http://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
updated guide. Information will be added on a weekly basis.

Browser Support
===============
A
almasaeed2010 已提交
54
- IE 9+
A
Abdullah Almsaeed 已提交
55 56 57 58 59 60 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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
- 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](http://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
reserves the right to change the license of future releases.

Change log
==========
**v2.0:**

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

**ver 1.2:**

A
almasaeed2010 已提交
118 119 120 121
- 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 已提交
122 123
**ver 1.1:**

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

A
Abdullah Almsaeed 已提交
127 128 129 130 131
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/)
A
almasaeed2010 已提交
132

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

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

A
Abdullah Almsaeed 已提交
137 138 139
Donations
=========
Donations are **greatly appreciated!**
A
almasaeed2010 已提交
140

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