mirror of https://github.com/ColorlibHQ/AdminLTE
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
# AdminLTE - Bootstrap 5 Admin Dashboard
|
|
|
|
[](https://www.npmjs.com/package/admin-lte)
|
|
[](https://packagist.org/packages/almasaeed2010/adminlte)
|
|
[](https://www.jsdelivr.com/package/npm/admin-lte)
|
|
[](https://discord.gg/jfdvjwFqfz)
|
|
[](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 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/)
|