cyoung 21641f7c7c Fix incorrect choice of words in README. (#2590 )		5 years ago
.github/ISSUE_TEMPLATE	updated issue template labels	5 years ago
build	fixed child indent on hover with nav-compact	5 years ago
dist	fixed child indent on hover with nav-compact	5 years ago
docs	Fixed typo in docs (#2586 )	5 years ago
pages	enhanced DataTables demo with responsive plugin	5 years ago
plugins	updated dependencies & devDependencies	5 years ago
.babelrc	plugins updates part 2	6 years ago
.browserslistrc	added .browserlistrc	5 years ago
.editorconfig	plugins updates part 2	6 years ago
.eslintignore	Dev release	7 years ago
.eslintrc	Dev release	7 years ago
.gitignore	added unnecessary plugin files (.md, .html & package.json) to .gitignore	5 years ago
.npmignore	fixed npm ignores	5 years ago
.travis.yml	moved exclude to matrix in .travis.yml	5 years ago
LICENSE	Dev release	7 years ago
README.md	Fix incorrect choice of words in README. (#2590 )	5 years ago
composer.json	Bootstarap 3 > 4	5 years ago
index.html	fixed aria related role="button" on pushmenu & control-sidebar links	5 years ago
index2.html	fixed aria related role="button" on pushmenu & control-sidebar links	5 years ago
index3.html	fixed aria related role="button" on pushmenu & control-sidebar links	5 years ago
package-lock.json	fixed npm audit	5 years ago
package.json	fixed npm audit	5 years ago
starter.html	fixed aria related role="button" on pushmenu & control-sidebar links	5 years ago

README.md

Introduction

AdminLTE is a fully responsive administration template. Based on Bootstrap 4 framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.

Preview on AdminLTE.io

Looking for Premium Templates?

AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable prices. Visit https://adminlte.io/premium for more information.

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.

Installation

There are multiple ways to install AdminLTE.

Download:

Download from Github releases.

Using The Command Line:

Via NPM

npm install admin-lte@^3.0 --save

Via Yarn

yarn add admin-lte@^3.0

Via Composer

composer require "almasaeed2010/adminlte=~3.0"

Via Git

Clone to your machine

git clone https://github.com/ColorlibHQ/AdminLTE.git

Documentation

Visit the online documentation for the most updated guide. Information will be added on a weekly basis.

Browser Support

IE 10+
Firefox (latest)
Chrome (latest)
Safari (latest)
Opera (latest)

Contribution

Contribution are always welcome and recommended! Here is how:

Fork the repository (here is the guide).
Clone to your machine git clone https://github.com/YOUR_USERNAME/AdminLTE.git
Create a new branch
Make your changes
Create a pull request

Compile dist files

To compile the dist files you need nodejs/npm, clone/download the repo then:

npm install (install npm deps)
Optional: npm run dev (developer mode, autocompile with browsersync support for live demo)
npm run production (compile css/js files)

Contribution Requirements:

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.
If you use content provided by another party, it must be appropriately licensed using an open source license.
Contributions are only accepted through Github pull requests.
Finally, contributed code must work in all supported browsers (see above for browser support).

License

AdminLTE is an open source project by AdminLTE.io that is licensed under MIT. AdminLTE.io reserves the right to change the license of future releases.

Legacy Releases

Change log

Visit the releases page to view the changelog

Image Credits