AdminLTE/README.md

60 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2021-05-14 03:23:59 +02:00
# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io)
2014-10-31 02:31:01 +01:00
2019-11-02 14:51:13 +01:00
[![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)
2021-01-28 20:09:32 +01:00
[![cdn version](https://data.jsdelivr.com/v1/package/npm/admin-lte/badge)](https://www.jsdelivr.com/package/npm/admin-lte)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
2021-07-28 21:22:14 +02:00
[![Discord Invite](https://img.shields.io/badge/discord-join%20now-green)](https://discord.gg/jfdvjwFqfz)
2019-11-02 14:51:13 +01:00
2021-05-14 03:23:59 +02:00
**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 5](https://getbootstrap.com/)** framework and also the JavaScript plugins.
2018-03-17 18:07:55 +01:00
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
2014-02-01 17:15:26 +01:00
2020-06-01 10:33:08 +02:00
## Looking for Premium Templates?
AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable
2020-06-01 10:33:08 +02:00
prices. Visit <https://adminlte.io/premium> for more information.
2014-02-01 20:18:02 +01:00
2018-03-17 18:11:26 +01:00
!["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation")
2014-02-01 17:15:26 +01:00
2018-03-17 18:07:55 +01:00
**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.
2014-02-01 17:15:26 +01:00
2021-02-14 14:27:47 +01:00
## Quick start
2015-02-22 20:12:01 +01:00
### Compile dist files
2020-06-01 10:33:08 +02:00
To compile the dist files you need Node.js/npm, clone/download the repo then:
1. `npm install` (install npm deps)
2021-05-17 05:18:09 +02:00
2. `npm install gulp-cli -g` (install gulp-cli globally)
3. _Optional:_ `gulp` (developer mode, autocompile with browsersync support for live demo)
4. `gulp build` (compile css/js files)
2015-02-22 20:12:01 +01:00
2021-02-14 14:27:47 +01:00
## Contributing
2021-05-14 03:23:59 +02:00
- Highly welcome.
- For your extra reference check [AdminLTE v3 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.
- Go to Cloned Folder.
- In cli/bash run `npm install` it will install dependency from `package.json`.
- After installation complets, run `npm run dev`
- Cool, Send urs changes.
2021-02-14 14:27:47 +01:00
2020-06-01 10:33:08 +02:00
## 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.
2021-07-18 13:44:24 +02:00
## 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/)