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

293 lines
9.9 KiB

10 years ago
Introduction
============
10 years ago
![Bower version](https://img.shields.io/bower/v/adminlte.svg)
[![npm version](https://img.shields.io/npm/v/admin-lte.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
9 years ago
**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.
11 years ago
10 years ago
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
10 years ago
Looking for Premium Templates?
10 years ago
------------------------------
10 years ago
**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.**
11 years ago
11 years ago
10 years ago
!["AdminLTE Presentation"] (https://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](https://almsaeedstudio.com) and download the latest release.
10 years ago
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/)).
10 years ago
- 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
**npm**
```
npm install --save 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](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most
10 years ago
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](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
10 years ago
reserves the right to change the license of future releases.
10 years ago
Todo List
---------
10 years ago
- ~~Light sidebar colors~~ (Done v2.1.0)
- ~~Right sidebar~~ (Done v2.1.0)
- ~~Minified main-sidebar~~ (Done v2.1.0)
10 years ago
- Right to left support
9 years ago
- ~~Custom pace style~~ (Done v2.3.1)
10 years ago
9 years ago
Legacy Releases
10 years ago
----------------
9 years ago
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://almsaeedstudio.com/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.
10 years ago
10 years ago
Change log
10 years ago
----------
**For the most recent change log, visit the [releases page](https://github.com/almasaeed2010/AdminLTE/releases).** We will add a detailed release notes to each new release.
**v2.3.3:**
- Update version number
- Merge pull request #976 from suvjunmd/markup
- Merge pull request #983 from johnberberich/fix-help-block-validation
- Apply form validation state colors to help blocks
- Fixed W3C Markup Validation errors and warnings
- Merge #918. Fix date-range button selection issue
- Merge pull request #944 from bluemanos/master
- Merge pull request #935 from schulzetenberg/master
- Merge pull request #904 from 0xMatt/master
- Merge pull request #816 from magikMaker/feature/package-json
- Fix #957. Make pace visible in skin black
- Update ckeditor
- Fix typo
- updated momentjs library to 2.11.2
- update font-awesome to 4.5.0, change CDN to cdnjs.com
- Fix sentence
- Update README.md
- Formatting fix
- Add datepicker plugin to examples
- Merge remote-tracking branch 'refs/remotes/almasaeed2010/master'
- Update License
- Improve click event handler
- Merge pull request #877 from suvjunmd/jQuery
- Add Laravel implementation #858
- Updated jQuery to version 2.2.0
- Fix issue #812
- Update BS to v3.3.6
- Merge pull
- Add .sass-cache to gitignore
- Merge pull request #822 from condor-bird/patch-5
- Merge pull request #818 from gabel/update_bootstrap_slider
- Merge pull request #821 from pdesmarais/master
- Merge pull request #829 from gabel/update_momentjs
- Merge pull request #831 from gabel/update_colorpicker
- Merge pull request #854 from aqnouch/patch-1
- Merge pull request #825 from gabel/update_select2
- Updated copyright to 2016
- Update to bootstrap-colorpicker version 2.3.0
- update moment.js cdn links to version 2.10.6
- Update to select2 version 4.0.1
- Duplicate attribute type button
- Changing the img paths in the css files
- Updating to ion.RangeSlider v2.1.2
- update to bootsrap-slider 5.3.1
- added npm install to readme
- added main property to package.json
**v2.3.2:**
- Fix issue #752 (badges, labels and arrows didn't align on sidebar menu properly on FireFox)
9 years ago
**v2.3.1:**
- Fix sidebar issue #676
- Fix BootLint warnings and errors
- Minor bug fixes and code reformat
9 years ago
- Added Pace page
9 years ago
**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
**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
- 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
**v2.2.0:**
10 years ago
- Bug fixes
- Added support for [Select2](https://select2.github.io/)
- Updated ChartJS
10 years ago
**v2.1.2:**
- Added explicit BoxWidget activation function issue #450
- Crushed some bugs
**v2.1.1:**
- Fix version error
**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
10 years ago
**v2.0.5:**
- Fixed issue #288
10 years ago
**v2.0.4:**
- Fixed bower.json to pick up newest release.
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
10 years ago
- Change in color scheme to a more complementing scheme
10 years ago
- 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
10 years ago
- Updated Bootstrap to 3.3.2
10 years ago
- 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.
10 years ago
- 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")