2020-06-01 10:33:08 +02:00
# Introduction
2014-10-31 02:31:01 +01:00
2019-11-02 14:51:13 +01:00
[![npm version ](https://img.shields.io/npm/v/admin-lte/latest.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)
2020-06-08 12:31:05 +02:00
**AdminLTE** is a fully responsive administration template. Based on ** [Bootstrap 4.4 ](https://getbootstrap.com/ )** framework and also the JS/jQuery plugin.
2018-03-17 18:07:55 +01:00
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
2014-02-01 17:15:26 +01:00
2019-11-02 13:33:03 +01:00
**Preview on [AdminLTE.io ](https://adminlte.io/themes/v3 )**
2014-03-24 15:44:44 +01:00
2020-06-01 10:33:08 +02:00
## Looking for Premium Templates?
2020-03-09 21:02:39 +01:00
AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable
2020-06-01 10:33:08 +02:00
prices. Visit < https: / / adminlte . io / premium > for more information.
2014-02-01 20:18:02 +01:00
2018-03-17 18:11:26 +01:00
!["AdminLTE Presentation" ](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation" )
2014-02-01 17:15:26 +01:00
2018-03-17 18:07:55 +01:00
**AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files.
SCSS has been used to increase code customizability.
2014-02-01 17:15:26 +01:00
2020-06-01 10:33:08 +02:00
## Installation
2015-02-22 20:12:01 +01:00
There are multiple ways to install AdminLTE.
2020-06-01 10:33:08 +02:00
### Download:
2015-02-23 01:59:19 +01:00
2020-05-31 13:11:55 +02:00
Download from [GitHub releases ](https://github.com/ColorlibHQ/AdminLTE/releases ).
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
### Using The Command Line:
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._
2020-04-03 21:24:11 +02:00
2020-06-01 10:33:08 +02:00
- **Via npm**
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
```bash
npm install admin-lte@^3.0 --save
```
2019-11-02 13:33:03 +01:00
2020-06-01 10:33:08 +02:00
- **Via Yarn**
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
```bash
yarn add admin-lte@^3.0
```
- **Via Composer**
```bash
composer require "almasaeed2010/adminlte=~3.0"
```
- **Via Git**
Clone to your machine
```bash
git clone https://github.com/ColorlibHQ/AdminLTE.git
```
## Documentation
2015-02-22 20:12:01 +01:00
2019-11-02 13:33:03 +01:00
Visit the [online documentation ](https://adminlte.io/docs/3.0/ ) for the most
2015-02-22 20:12:01 +01:00
updated guide. Information will be added on a weekly basis.
2020-06-01 10:33:08 +02:00
## Browser Support
2018-03-17 18:07:55 +01:00
- IE 10+
2015-02-22 20:12:01 +01:00
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)
2020-04-15 07:47:13 +02:00
- Microsoft Edge (latest)
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
## Contributions
Contributions are always **welcome and recommended** ! Here is how:
2015-02-22 20:12:01 +01:00
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
2020-06-01 10:33:08 +02:00
- Clone to your machine
```bash
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
2018-03-17 18:07:55 +01:00
- Create a new branch
2015-02-22 20:12:01 +01:00
- Make your changes
- Create a pull request
2020-06-01 10:33:08 +02:00
### Compile dist files
To compile the dist files you need Node.js/npm, clone/download the repo then:
2019-11-02 16:18:08 +01:00
1. `npm install` (install npm deps)
2020-01-14 14:51:29 +01:00
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
2019-11-02 16:18:08 +01:00
3. `npm run production` (compile css/js files)
2015-02-23 01:59:19 +01:00
2020-06-01 10:33:08 +02: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.
2020-05-31 14:28:48 +02:00
- If you use content provided by another party, it must be appropriately licensed using an [open source ](https://opensource.org/licenses ) license.
2020-05-31 13:11:55 +02:00
- Contributions are only accepted through GitHub pull requests.
2015-02-22 20:12:01 +01:00
- Finally, contributed code must work in all supported browsers (see above for browser support).
2020-06-01 10:33:08 +02:00
## License
AdminLTE is an open source project by [AdminLTE.io ](https://adminlte.io ) that is licensed under [MIT ](https://opensource.org/licenses/MIT ).
AdminLTE.io reserves the right to change the license of future releases.
## Latest Release
2015-02-22 20:12:01 +01:00
2020-04-15 07:47:13 +02:00
- [AdminLTE 3 ](https://github.com/ColorlibHQ/AdminLTE/releases/latest )
2020-06-01 10:33:08 +02:00
## Legacy Releases
2019-11-02 13:33:03 +01:00
- [AdminLTE 2 ](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18 )
2019-06-06 14:32:53 +02:00
- [AdminLTE 1 ](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1 )
2015-02-23 01:55:00 +01:00
2020-06-01 10:33:08 +02:00
## Changelog
2015-02-22 20:12:01 +01:00
2020-06-01 10:33:08 +02:00
Visit the [releases ](https://github.com/ColorlibHQ/AdminLTE/releases ) page to view the changelog
2014-02-01 17:15:26 +01:00
2020-06-01 10:33:08 +02:00
## Image Credits
2014-02-01 17:15:26 +01:00
2020-06-01 10:33:08 +02:00
- [Pixeden ](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd )
- [Graphicsfuel ](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/ )
- [Pickaface ](https://pickaface.net/ )
- [Unsplash ](https://unsplash.com/ )
- [Uifaces ](http://uifaces.com/ )