github
/
AdminLTE
mirror of https://github.com/ColorlibHQ/AdminLTE
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md 

README Enhancement: Streamlined Content, Clearer Instructions, and Emphasized Features
pull/5573/head
Vladislav Tymoshchuk 2024-04-27 17:19:54 +03:00
parent 06b4e04d8b
commit 674248c097
1 changed files with 24 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -1,4 +1,4 @@
# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io) # AdminLTE - Bootstrap 5 Admin Dashboard
[![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte) [![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) [![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
@ -6,53 +6,46 @@
[![Discord Invite](https://img.shields.io/badge/discord-join%20now-green)](https://discord.gg/jfdvjwFqfz) [![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) [![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. Based on **[Bootstrap 5](https://getbootstrap.com/)** framework and also the JavaScript plugins. **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.
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
## Looking for Premium Templates? ## Premium Templates
AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable Explore our premium templates for top-notch quality and affordability at [AdminLTE Premium](https://adminlte.io/premium).
prices. Visit <https://adminlte.io/premium> for more information.
!["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation") ![AdminLTE Presentation](https://adminlte.io/AdminLTE3.png)
**AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files. AdminLTE is meticulously coded with clear comments in JS, SCSS, and HTML files. SCSS enhances code customizability.
SCSS has been used to increase code customizability.
## Quick start ## Quick Start
### Compile dist files ### Installation and Compilation
To compile the dist files you need Node.js/npm, clone/download the repo then: To compile the distribution files, ensure you have Node.js/npm installed:
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)
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 ## Contributing
- Highly welcome. We welcome contributions! Here's how to get started:
- For your extra reference check [AdminLTE v4 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing)
- First thing first, you should have bit knowledge about NodeJS. 1. Familiarize yourself with Node.js and GitHub.
- Github Knowledge. 2. Clone this repository and switch to the `master` branch.
- Install NodeJS LTS version. 3. Navigate to the cloned folder and run `npm install` to install dependencies.
- Clone this Repository to your machine and change to `master` branch. 4. Run `npm run dev` after installation.
- Go to Cloned Folder. 5. Make your changes and submit a pull request to the `master` branch.
- In cli/bash run `npm install` it will install dependency from `package.json`.
- After installation completes, run `npm run dev` For detailed instructions, refer to the [AdminLTE v4 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing).
- Cool, Send urs changes in PR to `master` branch.
## Sponsorship ## Sponsorship
Support AdminLTE development by becoming a sponsor. Support AdminLTE development by becoming a sponsor via [GitHub Sponsors](https://github.com/sponsors/danny007in) or [PayPal](https://www.paypal.me/daniel007in).
[Github Sponsors](https://github.com/sponsors/danny007in) or
[PayPal](https://www.paypal.me/daniel007in)
## License ## License
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT). 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.
AdminLTE.io reserves the right to change the license of future releases.
## Image Credits ## Image Credits