Go to file

Nisar Hassan Naqvi dfdb0f0665 make contributions easier via automating the dev setup. (#3110 )		2020-11-25 07:51:27 +01:00
.github	Tweak CI cache (#2904 )	2020-07-22 15:53:08 +02:00
build	Update _main-sidebar.scss (#3082 )	2020-11-25 07:50:13 +01:00
dist	add dark-mode checkbox in demo.js	2020-09-24 11:03:13 +02:00
docs	Bump jekyll-seo-tag from 2.6.1 to 2.7.1 in /docs (#3098 )	2020-11-25 07:35:30 +01:00
pages	fix html validator error	2020-11-25 07:33:04 +01:00
plugins	add datatables searchpanes plugin	2020-11-24 09:38:21 +01:00
.babelrc.js	Update .babelrc.js	2020-06-28 08:38:42 +03:00
.browserslistrc	Update .browserslistrc (#2849 )	2020-06-27 17:54:31 +02:00
.bundlewatch.config.json	raise bundlewatch limits	2020-09-25 12:35:13 +02:00
.editorconfig	Update .editorconfig (#2749 )	2020-06-01 10:33:50 +02:00
.eslintignore	Update .eslintignore (#2759 )	2020-06-01 20:14:13 +02:00
.eslintrc.json	Use template literals (#2835 )	2020-06-13 14:34:10 +02:00
.gitattributes	Enforce LF. (#2717 )	2020-05-30 13:00:13 +02:00
.gitignore	remove flot-old and add flot plugins from flot/source folder (#2924 )	2020-07-24 22:13:20 +02:00
.gitpod.yml	make contributions easier via automating the dev setup. (#3110 )	2020-11-25 07:51:27 +01:00
.lgtm.yml	Improve LGTM configuration (#2777 )	2020-06-02 16:38:46 +02:00
.npmignore	Remove docs from the npm package	2020-06-05 17:02:09 +03:00
.stylelintignore	Add Stylelint.	2020-06-01 14:09:56 +03:00
.stylelintrc	Add Stylelint.	2020-06-01 14:09:56 +03:00
composer.json	Use https when possible. (#2733 )	2020-05-31 14:28:48 +02:00
index.html	add kanban demo	2020-09-24 10:58:07 +02:00
index2.html	add kanban demo	2020-09-24 10:58:07 +02:00
index3.html	add kanban demo	2020-09-24 10:58:07 +02:00
LICENSE	updated readme and license (#2653 )	2020-04-15 07:47:13 +02:00
package-lock.json	Bump terser from 5.3.2 to 5.5.0 (#3142 )	2020-11-25 07:47:52 +01:00
package.json	Bump terser from 5.3.2 to 5.5.0 (#3142 )	2020-11-25 07:47:52 +01:00
README.md	make contributions easier via automating the dev setup. (#3110 )	2020-11-25 07:51:27 +01:00
starter.html	remove text-dark on content header	2020-09-23 09:50:37 +02:00

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)

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.

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.