mirror of https://github.com/ColorlibHQ/AdminLTE
Updated README.md
parent
877bedc208
commit
da2d2c2adb
184
README.md
184
README.md
|
@ -1,102 +1,134 @@
|
|||
[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=almasaeed2010&url=http://almsaeedstudio.com&title=AdminLTE&language=&tags=github&category=software) [![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")
|
||||
------------------------
|
||||
|
||||
Announcements:
|
||||
--------------
|
||||
**Current AdminLTE version in master is v2 Beta 1**
|
||||
Introduction
|
||||
============
|
||||
|
||||
**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.
|
||||
|
||||
**Live Preview: http://almsaeedstudio.com/preview/**
|
||||
**Download & Preview on [Almsaeed Studio](http://almsaeedstudio.com)**
|
||||
|
||||
Note: If the javascript in the preview does not work properly (specially IE users), please visit http://almsaeedstudio.com/AdminLTE (this could be because of the use of an iframe!)
|
||||
|
||||
Want More?
|
||||
-----------
|
||||
Looking for Premium Templates?
|
||||
==============================
|
||||
**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.**
|
||||
|
||||
|
||||
!["AdminLTE Presentation"](http://almsaeedstudio.com/adminlte2.png "AdminLTE Presentation")
|
||||
!["AdminLTE Presentation"] (http://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
|
||||
|
||||
**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.
|
||||
|
||||
Special Features:
|
||||
-----------------
|
||||
- **Fully responsive**
|
||||
- **Enhanced for printing**
|
||||
- **Sortable dashboard widgets**
|
||||
- **18 plugins and 3 custom plugins**
|
||||
- **Light weight and fast**
|
||||
- **Compatible with most major browsers**
|
||||
- **Full support for Glyphicons, Fontawesome and Ion icons**
|
||||
Installation
|
||||
============
|
||||
There are multiple ways to install AdminLTE.
|
||||
|
||||
Featured Pages:
|
||||
----------------
|
||||
- Dashboard
|
||||
- Mailbox
|
||||
- Calendar
|
||||
- Invoice
|
||||
- Lockscreen
|
||||
- Login
|
||||
- Register
|
||||
- 404 Error
|
||||
- 500 Error
|
||||
- Blank page
|
||||
Download:
|
||||
---------
|
||||
Download from Github or [visit Almsaeed Studio](http://almsaeedstudio.com) and download the lateset release.
|
||||
|
||||
Featured Plugins:
|
||||
-----------------
|
||||
- Boostrap Slider
|
||||
- Ion slider
|
||||
- Bootstrap WYSIHTML5
|
||||
- CKEditor
|
||||
- Bootstrap Colorpicker
|
||||
- Bootstrap Date range Picker
|
||||
- Bootstrap Time Picker
|
||||
- Data Tables
|
||||
- Flot
|
||||
- Morris.js
|
||||
- Sparkilne
|
||||
- Full Calendar
|
||||
- iCheck
|
||||
- jQuery input mask
|
||||
- jQuery Knob
|
||||
- jVector Map
|
||||
- Slim Scroll
|
||||
- Pace
|
||||
- [Bootstrap Social Buttons](http://lipis.github.io/bootstrap-social/ "Bootstrap Social")
|
||||
Using The Command Line:
|
||||
-----------------------
|
||||
**Github**
|
||||
|
||||
Browser Support:
|
||||
----------------
|
||||
- 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"```
|
||||
|
||||
**Bower**
|
||||
|
||||
```bower install git://github.com/almasaeed2010/AdminLTE.git```
|
||||
|
||||
**Composer**
|
||||
|
||||
```composer require "almasaeed2010/adminlte=~2.0"```
|
||||
|
||||
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
|
||||
===============
|
||||
- IE 9+
|
||||
- Firefox 5+
|
||||
- Chrome 14+
|
||||
- Safari 5+
|
||||
- Opera 11+
|
||||
- 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:**
|
||||
|
||||
Change log:
|
||||
-----------
|
||||
ver 1.2:
|
||||
- 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").
|
||||
|
||||
ver 1.1:
|
||||
**ver 1.1:**
|
||||
|
||||
- Added new skin. class: .skin-black
|
||||
- Added [pace](http://github.hubspot.com/pace/docs/welcome/ "pace") plugin.
|
||||
|
||||
To Do List:
|
||||
-----------
|
||||
- More features
|
||||
- Ajax version
|
||||
- More skins
|
||||
- Documentation
|
||||
Image Credits
|
||||
=============
|
||||
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
|
||||
|
||||
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/)
|
||||
|
||||
[graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/ "")
|
||||
[Pickaface](http://pickaface.net/)
|
||||
|
||||
[ajaxload](http://www.ajaxload.info/ "")
|
||||
[Unsplash](https://unsplash.com/)
|
||||
|
||||
[pickaface](http://pickaface.net/ "")
|
||||
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")
|
Loading…
Reference in New Issue