AdminLTE/README.md

# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io)

[![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
[![cdn version](https://data.jsdelivr.com/v1/package/npm/admin-lte/badge)](https://www.jsdelivr.com/package/npm/admin-lte)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 5](https://getbootstrap.com/)** framework and also the JavaScript plugins.
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.

## 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"](https://adminlte.io/AdminLTE3.png "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

### 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

- Highly welcome.
- For your extra reference check [AdminLTE v3 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing)
- First thing first, you should have bit knowledge about NodeJS.
- Github Knowledge.
- Install NodeJS LTS version.
- Clone this Repository to your machine.
- Go to Cloned Folder.
- In cli/bash run `npm install` it will install dependency from `package.json`.
- After installation complets, run `npm run dev`
- Cool, Send urs changes.


## License

AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT).
AdminLTE.io reserves the right to change the license of future releases.
Update README.md 2021-05-14 01:23:59 +00:00			`# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io)`
Added docs link 2014-10-31 01:31:01 +00:00
Updated README.md 2019-11-02 13:51:13 +00:00			`[![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte)`
			`[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)`
docs and readme update 2021-01-28 19:09:32 +00:00			`[![cdn version](https://data.jsdelivr.com/v1/package/npm/admin-lte/badge)](https://www.jsdelivr.com/package/npm/admin-lte)`
make contributions easier via automating the dev setup. (#3110) 2020-11-25 06:51:27 +00:00			`[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)`
Updated README.md 2019-11-02 13:51:13 +00:00
Update README.md 2021-05-14 01:23:59 +00:00			`AdminLTE is a fully responsive administration template. Based on [Bootstrap 5](https://getbootstrap.com/) framework and also the JavaScript plugins.`
Dev release 2018-03-17 17:07:55 +00:00			`Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.`
Create README.md 2014-02-01 16:15:26 +00:00
Assorted Markdown tweaks (#2750) 2020-06-01 08:33:08 +00:00			`## Looking for Premium Templates?`

Fix incorrect choice of words in README. (#2590) 2020-03-09 20:02:39 +00:00			`AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable`
Assorted Markdown tweaks (#2750) 2020-06-01 08:33:08 +00:00			`prices. Visit <https://adminlte.io/premium> for more information.`
Update README.md 2014-02-01 19:18:02 +00:00
Fix img in readme 2018-03-17 17:11:26 +00:00			`!["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation")`
Create README.md 2014-02-01 16:15:26 +00:00
Dev release 2018-03-17 17:07:55 +00:00			`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.`
Create README.md 2014-02-01 16:15:26 +00:00
improve docs 2021-02-14 13:27:47 +00:00			`## Quick start`
Updated README.md 2015-02-22 19:12:01 +00:00
Update README.md (#3118) Co-authored-by: REJack <info@rejack.de> 2020-11-25 06:53:27 +00:00			`### Compile dist files`
Assorted Markdown tweaks (#2750) 2020-06-01 08:33:08 +00:00
Update README.md (#3118) Co-authored-by: REJack <info@rejack.de> 2020-11-25 06:53:27 +00:00			`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)
Updated README.md 2015-02-22 19:12:01 +00:00
improve docs 2021-02-14 13:27:47 +00:00
			`## Contributing`

Update README.md 2021-05-14 01:23:59 +00:00			`- Highly welcome.`
			`- For your extra reference check [AdminLTE v3 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing)`
			`- First thing first, you should have bit knowledge about NodeJS.`
			`- Github Knowledge.`
			`- Install NodeJS LTS version.`
			`- Clone this Repository to your machine.`
			`- Go to Cloned Folder.`
			- In cli/bash run `npm install` it will install dependency from `package.json`.
			- After installation complets, run `npm run dev`
			`- Cool, Send urs changes.`
improve docs 2021-02-14 13:27:47 +00:00

Assorted Markdown tweaks (#2750) 2020-06-01 08:33:08 +00:00			`## License`

			`AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT).`
			`AdminLTE.io reserves the right to change the license of future releases.`