Go to file

REJack 5ed7e97288 Merge pull request #2797 from XhmikosR/docs Fix docs		5 years ago
.github	docs action: fix cache (#2795 )	5 years ago
build	Add back jsgrid/demos/db.js (#2810 )	5 years ago
dist	Remove the executable permission. (#2768 )	5 years ago
docs	Markdown tweaks	5 years ago
pages	Fix typo in comment (#2813 )	5 years ago
plugins	Add back jsgrid/demos/db.js (#2810 )	5 years ago
.babelrc.js	Update to `rollup/plugin-babel`	5 years ago
.browserslistrc	added .browserlistrc	5 years ago
.bundlewatch.config.json	bump bundlewatch size	5 years ago
.editorconfig	Update .editorconfig (#2749 )	5 years ago
.eslintignore	Update .eslintignore (#2759 )	5 years ago
.eslintrc.json	Add ESLint support.	5 years ago
.gitattributes	Enforce LF. (#2717 )	5 years ago
.gitignore	Update .gitignore (#2773 )	5 years ago
.lgtm.yml	Improve LGTM configuration (#2777 )	5 years ago
.npmignore	Remove docs from the npm package	5 years ago
.stylelintignore	Add Stylelint.	5 years ago
.stylelintrc	Add Stylelint.	5 years ago
LICENSE	updated readme and license (#2653 )	5 years ago
README.md	Assorted Markdown tweaks (#2750 )	5 years ago
composer.json	Use https when possible. (#2733 )	5 years ago
index.html	Fix typo in comment (#2813 )	5 years ago
index2.html	Add missing trailing slash in docs link. (#2812 )	5 years ago
index3.html	Add missing trailing slash in docs link. (#2812 )	5 years ago
package-lock.json	Update devDependencies and gems (#2796 )	5 years ago
package.json	Update devDependencies and gems (#2796 )	5 years ago
starter.html	Remove the obsolete `X-UA-Compatible`	5 years ago

README.md

Introduction

AdminLTE is a fully responsive administration template. Based on Bootstrap 4.4 framework and also the JS/jQuery plugin. 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:

Important Note: To install it via npm/Yarn, you need at least Node.js 10 or higher.

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)
Microsoft Edge (latest)

Contributions

Contributions 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 Node.js/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.