You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
AdminLTE/README.md

173 lines
5.8 KiB

10 years ago
Introduction
============
10 years ago
11 years ago
**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.
10 years ago
**Download & Preview on [Almsaeed Studio](http://almsaeedstudio.com)**
10 years ago
Looking for Premium Templates?
10 years ago
------------------------------
11 years ago
**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.**
11 years ago
10 years ago
!["AdminLTE Presentation"] (http://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation")
11 years ago
**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.
10 years ago
Installation
10 years ago
------------
10 years ago
There are multiple ways to install AdminLTE.
10 years ago
####Download:
10 years ago
Download from Github or [visit Almsaeed Studio](http://almsaeedstudio.com) and download the lateset release.
10 years ago
####Using The Command Line:
10 years ago
**Github**
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
- Clone to your machine
```
10 years ago
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
10 years ago
**Bower**
```
10 years ago
bower install admin-lte
```
10 years ago
**Composer**
```
composer require "almasaeed2010/adminlte=~2.0"
```
10 years ago
Documentation
10 years ago
-------------
10 years ago
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
10 years ago
---------------
- IE 9+
10 years ago
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)
Contribution
10 years ago
------------
10 years ago
Contribution are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
10 years ago
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
10 years ago
- Make your changes
- Create a pull request
10 years ago
#### Contribution Requirements:
10 years ago
- 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
10 years ago
-------
10 years ago
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.
10 years ago
Todo List
---------
- Light sidebar colors
- Right sidebar
- Minified main-sidebar
- Right to left support
- Custom pace style
10 years ago
Legacy Realeases
10 years ago
----------------
10 years ago
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](http://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.
10 years ago
Change log
10 years ago
----------
**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
10 years ago
- Fixed checkbox out of bounds issue in WYSIHTML5 editor.
10 years ago
**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
10 years ago
**v2.0.0:**
10 years ago
- 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.
10 years ago
**ver 1.2.0:**
10 years ago
- 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").
10 years ago
**ver 1.1.0:**
10 years ago
- Added new skin. class: .skin-black
- Added [pace](http://github.hubspot.com/pace/docs/welcome/ "pace") plugin.
10 years ago
Image Credits
10 years ago
-------------
10 years ago
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
11 years ago
10 years ago
[Pickaface](http://pickaface.net/)
11 years ago
10 years ago
[Unsplash](https://unsplash.com/)
11 years ago
[Uifaces](http://uifaces.com/)
10 years ago
Donations
10 years ago
---------
10 years ago
Donations are **greatly appreciated!**
11 years ago
10 years ago
[![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")