AdminLTE/README.md

229 lines
7.4 KiB
Markdown
Raw Normal View History

2015-02-22 20:12:01 +01:00
Introduction
============
2014-10-31 02:31:01 +01:00
2015-08-04 23:56:56 +02:00
**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.
2014-02-01 17:15:26 +01:00
2018-02-04 00:45:19 +01:00
**Download & Preview on [AdminLTE.io](https://adminlte.io)**
2015-02-22 20:12:01 +01:00
Looking for Premium Templates?
2015-02-23 01:59:19 +01:00
------------------------------
2018-02-04 00:45:19 +01:00
**AdminLTE.io just opened a new premium templates page. Hand picked to insure the best quality and the most affordable prices. Visit https://adminlte.io/premium for more information.**
2014-04-03 00:52:34 +02:00
2014-02-01 20:18:02 +01:00
2018-02-04 00:45:19 +01:00
!["AdminLTE Presentation"] (https://adminlte.io/AdminLTE2.png "AdminLTE Presentation")
2014-02-01 17:15:26 +01:00
**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.
2015-02-22 20:12:01 +01:00
Installation
2015-02-23 01:59:19 +01:00
------------
2015-02-22 20:12:01 +01:00
There are multiple ways to install AdminLTE.
2015-02-23 01:59:19 +01:00
####Download:
2018-02-04 00:45:19 +01:00
Download from Github or [visit AdminLTE.io](https://adminlte.io) and download the latest release.
2015-02-22 20:12:01 +01:00
2015-02-23 01:59:19 +01:00
####Using The Command Line:
2015-02-22 20:12:01 +01:00
**Github**
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
2015-07-12 15:46:20 +02:00
- Clone to your machine
2015-02-22 20:15:19 +01:00
```
2015-03-04 17:12:30 +01:00
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
2015-02-22 20:15:19 +01:00
```
2015-02-22 20:12:01 +01:00
**Bower**
2015-02-22 20:15:19 +01:00
```
2015-03-02 01:19:53 +01:00
bower install admin-lte
2015-02-22 20:15:19 +01:00
```
2015-02-22 20:12:01 +01:00
**Composer**
2015-02-22 20:15:19 +01:00
```
composer require "almasaeed2010/adminlte=~2.0"
```
2015-02-22 20:12:01 +01:00
Documentation
2015-02-23 01:59:19 +01:00
-------------
2018-02-04 00:45:19 +01:00
Visit the [online documentation](https://adminlte.io/themes/AdminLTE/documentation/index.html) for the most
2015-02-22 20:12:01 +01:00
updated guide. Information will be added on a weekly basis.
Browser Support
2015-02-23 01:59:19 +01:00
---------------
2014-02-02 18:58:21 +01:00
- IE 9+
2015-02-22 20:12:01 +01:00
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)
Contribution
2015-02-23 01:59:19 +01:00
------------
2015-02-22 20:12:01 +01:00
Contribution are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
2015-03-04 17:12:30 +01:00
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
2015-02-22 20:12:01 +01:00
- Make your changes
- Create a pull request
2015-02-23 01:59:19 +01:00
#### Contribution Requirements:
2018-02-04 00:45:19 +01:00
- When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate.
2015-02-22 20:12:01 +01:00
- 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
2015-02-23 01:59:19 +01:00
-------
2018-02-04 00:45:19 +01:00
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](http://opensource.org/licenses/MIT). AdminLTE.io
2015-02-22 20:12:01 +01:00
reserves the right to change the license of future releases.
2015-03-02 01:19:53 +01:00
Todo List
---------
2015-04-04 04:55:46 +02:00
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
2015-03-02 01:19:53 +01:00
- Right to left support
2015-09-30 08:42:01 +02:00
- ~~Custom pace style~~ (Done v2.3.1)
2015-03-02 01:19:53 +01:00
2015-02-23 01:55:00 +01:00
Legacy Realeases
2015-02-23 01:59:19 +01:00
----------------
2018-02-04 00:45:19 +01:00
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://adminlte.io/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.
2015-02-23 01:55:00 +01:00
2015-02-22 20:12:01 +01:00
Change log
2015-02-23 01:59:19 +01:00
----------
2015-09-19 20:28:07 +02:00
**v2.3.1:**
- Fix sidebar issue #676
- Fix BootLint warnings and errors
- Minor bug fixes and code reformat
2015-09-30 08:42:01 +02:00
- Added Pace page
2015-09-19 20:28:07 +02:00
2015-08-17 02:48:55 +02:00
**v2.3.0:**
- Added social widgets (found in the widgets page)
- Added profile page
- Fix issue #430 (requires ```.hold-transition``` to be added to ```<body>```)
- Fix issue #578
- Fix issue #579
2015-07-25 01:27:21 +02:00
**v2.2.1:**
- Bug Fixes
- Removed many ```!important``` statements in css
- Activate boxWidget automatically when created after the page has loaded
- Activate sidebar menu treeview links automatically when created after the page has loaded
2015-08-08 19:29:46 +02:00
- Updated Font Awesome thanks to @Dennis14e
- Added JSHint to Grunt tasks (Find JS errors)
- Added CSSLint to Grunt tasks (Find CSS errors)
- Added Image to Grunt tasks (compress images)
- Added Clean to Grunt tasks (remove unwanted files like uncompressed images)
- Updated Bootstrap to 3.3.5
2015-07-25 01:27:21 +02:00
2015-08-17 02:48:55 +02:00
**v2.2.0:**
2015-07-08 23:12:41 +02:00
- Bug fixes
- Added support for [Select2](https://select2.github.io/)
- Updated ChartJS
2015-06-09 00:41:18 +02:00
**v2.1.2:**
- Added explicit BoxWidget activation function issue #450
- Crushed some bugs
**v2.1.1:**
- Fix version error
2015-05-07 02:16:11 +02:00
**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
2015-03-17 16:34:36 +01:00
**v2.0.5:**
- Fixed issue #288
2015-03-09 15:23:06 +01:00
**v2.0.4:**
- Fixed bower.json to pick up newest release.
2015-03-20 16:32:59 +01:00
2015-03-04 02:03:17 +01:00
**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
2015-03-04 06:01:02 +01:00
- Fixed checkbox out of bounds issue in WYSIHTML5 editor.
2015-03-04 02:03:17 +01:00
2015-02-27 02:27:46 +01:00
**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
2015-03-04 02:40:19 +01:00
**v2.0.0:**
2015-02-22 20:12:01 +01:00
- Major layout bug fixes
- Change in layout mark up
- Added transitions to the sidebar
- New skins and modified previous skins
2015-07-12 15:46:20 +02:00
- Change in color scheme to a more complementing scheme
2015-02-22 20:12:01 +01:00
- 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
2015-07-12 15:46:20 +02:00
- Updated Bootstrap to 3.3.2
2015-02-22 20:12:01 +01:00
- 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.
2015-03-04 02:40:19 +01:00
**ver 1.2.0:**
2015-02-22 20:12:01 +01:00
2014-04-06 02:12:30 +02:00
- Fixed the sidebar scroll issue when using the fixed layout.
- Added [Bootstrap Social Buttons](http://lipis.github.io/bootstrap-social/ "Bootstrap Social") plugin.
2015-07-12 15:46:20 +02:00
- Fixed RequireJS bug. Thanks to [StaticSphere](https://github.com/StaticSphere "github user").
2014-04-06 02:12:30 +02:00
2015-03-04 02:40:19 +01:00
**ver 1.1.0:**
2015-02-22 20:12:01 +01:00
2014-04-06 02:12:30 +02:00
- Added new skin. class: .skin-black
- Added [pace](http://github.hubspot.com/pace/docs/welcome/ "pace") plugin.
2015-02-22 20:12:01 +01:00
Image Credits
2015-02-23 01:59:19 +01:00
-------------
2015-02-22 20:12:01 +01:00
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
2014-02-01 17:15:26 +01:00
2015-02-22 20:12:01 +01:00
[Pickaface](http://pickaface.net/)
2014-02-01 17:15:26 +01:00
2015-02-22 20:12:01 +01:00
[Unsplash](https://unsplash.com/)
2014-02-01 17:15:26 +01:00
2015-02-28 03:20:59 +01:00
[Uifaces](http://uifaces.com/)
2015-02-22 20:12:01 +01:00
Donations
2015-02-23 01:59:19 +01:00
---------
2015-02-22 20:12:01 +01:00
Donations are **greatly appreciated!**
2014-02-01 17:15:26 +01:00
2015-02-23 01:55:00 +01:00
[![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")