mirror of https://github.com/ColorlibHQ/AdminLTE
120 lines
4.9 KiB
Markdown
120 lines
4.9 KiB
Markdown
# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io)
|
|
|
|
[](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. 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.
|
|
|
|
## What's New in v4.0.0-rc4
|
|
|
|
**Latest Release with Enhanced Performance & Updated Dependencies** - Fresh improvements for better development experience:
|
|
|
|
- **Updated Dependencies** - 8 npm packages updated to latest versions for improved security and performance
|
|
- **Refined Mobile Image Loading** - Streamlined path resolution by removing JavaScript runtime fixes
|
|
- **Better Performance** - Images now load faster with build-time path generation instead of runtime corrections
|
|
- **Latest Tooling** - Updated TypeScript, ESLint, Prettier, Astro, and build tools
|
|
- **Zero Runtime Errors** - Eliminated console errors from JavaScript path corrections
|
|
|
|
**Key Improvements:**
|
|
- ✅ All images use relative paths generated at build time
|
|
- ✅ No more JavaScript runtime path fixes causing console errors
|
|
- ✅ Faster image loading with optimal path resolution
|
|
- ✅ Latest development tools and security updates
|
|
- ✅ Production-ready with enhanced stability
|
|
|
|
**Install the latest:**
|
|
```bash
|
|
npm install admin-lte@4.0.0-rc4
|
|
```
|
|
|
|
See the [CHANGELOG.md](CHANGELOG.md) for complete details.
|
|
|
|
## 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** 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
|
|
|
|
### Development
|
|
|
|
To start developing with AdminLTE:
|
|
|
|
1. **Install dependencies:** `npm install`
|
|
2. **Start development server:** `npm start` *(opens browser at http://localhost:3000)*
|
|
3. **Start coding!** Files auto-compile and refresh on changes
|
|
|
|
### Production Build
|
|
|
|
To build for production:
|
|
|
|
1. **Full production build:** `npm run production` *(includes linting and optimization)*
|
|
2. **Quick build:** `npm run build` *(faster for development/testing)*
|
|
|
|
### Available Scripts
|
|
|
|
- `npm start` - Start development server with file watching
|
|
- `npm run build` - Build all assets for development
|
|
- `npm run production` - Full production build with linting and bundlewatch
|
|
- `npm run lint` - Run all linters (JS, CSS, docs, lockfile)
|
|
- `npm run css` - Build CSS only
|
|
- `npm run js` - Build JavaScript only
|
|
|
|
## Browser Support
|
|
|
|
AdminLTE supports all modern browsers with the latest Bootstrap 5.3.7:
|
|
- Chrome (latest)
|
|
- Firefox (latest)
|
|
- Safari (latest)
|
|
- Edge (latest)
|
|
|
|
## Platform Support
|
|
|
|
AdminLTE v4 build scripts work cross-platform:
|
|
- **Windows** - Command Prompt, PowerShell, Git Bash
|
|
- **macOS** - Terminal, iTerm2
|
|
- **Linux** - Bash, Zsh, and other Unix shells
|
|
|
|
All npm scripts use cross-platform utilities to ensure consistent behavior across different operating systems.
|
|
|
|
## Contributing
|
|
|
|
- Highly welcome.
|
|
- 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.
|
|
- Github Knowledge.
|
|
- Install NodeJS LTS version.
|
|
- Clone this Repository to your machine and change to `master` branch.
|
|
- Go to Cloned Folder.
|
|
- In cli/bash run `npm install` it will install dependency from `package.json`.
|
|
- After installation completes, run `npm start`
|
|
- Cool, Send your changes in PR to `master` branch.
|
|
|
|
## Sponsorship
|
|
|
|
Support AdminLTE development by becoming a sponsor.
|
|
[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) that is licensed under [MIT](https://opensource.org/licenses/MIT).
|
|
AdminLTE.io reserves the right to change the license of future releases.
|
|
|
|
## 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/)
|