AdminLTE/README.md

125 lines
4.5 KiB
Markdown
Raw Normal View History

2015-02-22 20:12:01 +01:00
Introduction
============
2014-10-31 02:31:01 +01:00
![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)
[![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte)
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
2015-03-23 03:27:58 +01:00
**Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)**
2015-02-22 20:12:01 +01:00
Looking for Premium Templates?
2015-02-23 01:59:19 +01:00
------------------------------
2017-01-12 07:32:33 +01:00
**Almsaeed studio just opened a new premium templates website. Hand picked to ensure the best quality and the most affordable prices. Visit https://themequarry.com for more information.**
2014-04-03 00:52:34 +02:00
2014-02-01 20:18:02 +01:00
2015-03-23 02:37:48 +01:00
!["AdminLTE Presentation"] (https://almsaeedstudio.com/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:
2015-05-09 13:07:26 +02:00
Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) 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
2015-11-30 14:48:50 +01:00
**npm**
```
npm install --save admin-lte
```
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
-------------
2015-03-23 02:37:48 +01:00
Visit the [online documentation](https://almsaeedstudio.com/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:
2015-02-22 20:12:01 +01:00
- 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
2015-02-23 01:59:19 +01:00
-------
2015-03-23 02:37:48 +01:00
AdminLTE is an open source project by [Almsaeed Studio](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio
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
2016-03-14 01:12:38 +01:00
Legacy Releases
2015-02-23 01:59:19 +01:00
----------------
2015-08-04 23:56:56 +02:00
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.
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
----------
2016-09-01 06:32:40 +02:00
**For the most recent change log, visit the [releases page](https://github.com/almasaeed2010/AdminLTE/releases) or the [changelog file](https://github.com/almasaeed2010/AdminLTE/blob/master/changelog.md).** We will add a detailed release notes to each new release.
2014-04-06 02:12:30 +02:00
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")