AdminLTE/README.md

2.7 KiB

AdminLTE - Bootstrap 5 Admin Dashboard

npm version Packagist cdn version Discord Invite Netlify Status

AdminLTE is a fully responsive administration template built with Bootstrap 5 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.

AdminLTE Presentation

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.

Sponsorship

Support AdminLTE development by becoming a sponsor via GitHub Sponsors or PayPal.

License

AdminLTE is an open-source project by AdminLTE.io licensed under MIT. Future releases may change the license.

Image Credits