3.9 KiB

Raw Blame History

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 insure 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 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.