Skip to content

Latest commit

 

History

History
142 lines (97 loc) · 7.69 KB

README.md

File metadata and controls

142 lines (97 loc) · 7.69 KB
Raw

Introduction

npm version Packagist cdn version Gitpod Ready-to-Code

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

Installation

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

How to Contribute

Contributions are always welcome and recommended! Here is how for beginner's: Get started with open source click here

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

  2. Installation :

    git clone https://github.com/YOUR_USERNAME/AdminLTE.git
    • Create a new branch

  3. Compile dist files (Development) :

    • To compile the dist files you need Node.js 10 or higher/npm (node package manager)
    • Delete ./package-lock.json file
    • npm install (install npm deps)
    • npm run dev (developer mode, autocompile with browsersync support for live demo)
    • Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
    • Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
    • npm run production (compile css/js files and test every pages are perfectly working fine, before creating pull request)

  4. Create a pull request

Online one-click setup for contributing

You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically:

  • clone the AdminLTE repo.
  • install the dependencies.
  • run yarn dev to start the server.

Open in Gitpod

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)

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