AdminLTE/README.md

# AdminLTE - Bootstrap 5 Admin Dashboard

[![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)
[![Discord Invite](https://img.shields.io/badge/discord-join%20now-green)](https://discord.gg/jfdvjwFqfz)
[![Netlify Status](https://api.netlify.com/api/v1/badges/1277b36b-08f3-43fa-826a-4b4d24614b3c/deploy-status)](https://app.netlify.com/sites/adminlte-v4/deploys)

**AdminLTE** is a fully responsive administration template built with **[Bootstrap 5](https://getbootstrap.com/)** framework and essential JavaScript plugins. It offers high customizability and ease of use, catering to various screen resolutions from mobile to desktop.

## Premium Templates

Explore our premium templates for top-notch quality and affordability at [AdminLTE Premium](https://adminlte.io/premium).

![AdminLTE Presentation](https://adminlte.io/AdminLTE3.png)

AdminLTE is meticulously coded with clear comments in JS, SCSS, and HTML files. SCSS enhances code customizability.

## Quick Start

### Installation and Compilation

To compile the distribution files, ensure you have Node.js/npm installed:

1. Clone/download the repository.
2. Run `npm install` to install dependencies.
3. Optionally, run `npm run dev` for developer mode with auto-compile and Browsersync support.
4. Run `npm run production` to compile CSS/JS files for production.

## Contributing

We welcome contributions! Here's how to get started:

1. Familiarize yourself with Node.js and GitHub.
2. Clone this repository and switch to the `master` branch.
3. Navigate to the cloned folder and run `npm install` to install dependencies.
4. Run `npm run dev` after installation.
5. Make your changes and submit a pull request to the `master` branch.

For detailed instructions, refer to the [AdminLTE v4 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing).

## Sponsorship

Support AdminLTE development by becoming a sponsor via [GitHub Sponsors](https://github.com/sponsors/danny007in) or [PayPal](https://www.paypal.me/daniel007in).

## License

AdminLTE is an open-source project by [AdminLTE.io](https://adminlte.io) licensed under [MIT](https://opensource.org/licenses/MIT). Future releases may change the license.

## Image Credits

- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
- [Graphicsfuel](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
- [Pickaface](https://pickaface.net/)
- [Unsplash](https://unsplash.com/)
- [Uifaces](http://uifaces.com/)