github
/
AdminLTE
mirror of https://github.com/ColorlibHQ/AdminLTE
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '25e2bfc909'
${ noResults }
AdminLTE/README.md

6.2 KiB
Raw Blame History

AdminLTE - Bootstrap 4 Admin Dashboard

npm version Packagist cdn version Gitpod Ready-to-Code

AdminLTE is a fully responsive administration template. Based on Bootstrap 4.6 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 Presentation"

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.

Quick start

There are multiple ways to install AdminLTE.

Download & Changelog:

Always Recommended to download from GitHub latest release AdminLTE 3 for bug free and latest features.
Visit the releases page to view the changelog.
Legacy Releases are AdminLTE 2 / AdminLTE 1.

Grab from jsdelivr CDN :

Important Note: You needed to add separately cdn links for plugins in your project.

<script src="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/js/adminlte.min.js"></script>

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/admin-lte@3.1/dist/css/adminlte.min.css">

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.1 --save

  • Via Yarn

    yarn add admin-lte@^3.1

  • Via Composer

    composer require "almasaeed2010/adminlte=~3.1"

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

Browsers support

IE / Edge
IE / Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 iOS Safari
iOS Safari		 Samsung
Samsung		 Opera
Opera		 Vivaldi
Vivaldi		 Electron
Electron
IE10, IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

Compile dist files

To compile the dist files you need Node.js/npm, clone/download the repo then:

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

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

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.

Image Credits