mirror of https://github.com/ColorlibHQ/AdminLTE
96 lines
3.1 KiB
Markdown
96 lines
3.1 KiB
Markdown
Introduction
|
|
============
|
|
|
|
**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4](https://getbootstrap.com)** framework.
|
|
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
|
|
|
|
**Download & Preview on [AdminLTE.io](https://adminlte.io)**
|
|
|
|
Looking for Premium Templates?
|
|
------------------------------
|
|
AdminLTE.io just opened a new premium templates page. Hand picked to insure 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.
|
|
|
|
Installation
|
|
------------
|
|
There are multiple ways to install AdminLTE.
|
|
|
|
#### Download:
|
|
|
|
Download from Github or [visit AdminLTE.io](https://adminlte.io) and download the latest release.
|
|
|
|
#### Using The Command Line:
|
|
|
|
**NPM**
|
|
```bash
|
|
npm install admin-lte
|
|
```
|
|
|
|
**Github**
|
|
|
|
- Clone to your machine
|
|
```
|
|
git clone https://github.com/ColorlibHQ/AdminLTE.git
|
|
```
|
|
|
|
Documentation
|
|
-------------
|
|
Visit the [online documentation](https://adminlte.io/themes/AdminLTE/documentation/index.html) for the most
|
|
updated guide. Information will be added on a weekly basis.
|
|
|
|
Browser Support
|
|
---------------
|
|
- IE 10+
|
|
- Firefox (latest)
|
|
- Chrome (latest)
|
|
- Safari (latest)
|
|
- Opera (latest)
|
|
|
|
Contribution
|
|
------------
|
|
Contribution are always **welcome and recommended**! Here is how:
|
|
|
|
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
|
|
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
|
|
- Create a new branch
|
|
- Make your changes
|
|
- Create a pull request
|
|
|
|
#### Contribution Requirements:
|
|
|
|
- When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate.
|
|
- If you use content provided by another party, it must be appropriately licensed using an [open source](http://opensource.org/licenses) license.
|
|
- Contributions are only accepted through Github pull requests.
|
|
- Finally, contributed code must work in all supported browsers (see above for browser support).
|
|
|
|
License
|
|
-------
|
|
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](http://opensource.org/licenses/MIT). AdminLTE.io
|
|
reserves the right to change the license of future releases.
|
|
|
|
Legacy Releases
|
|
---------------
|
|
- [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.3)
|
|
- [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1)
|
|
|
|
Change log
|
|
----------
|
|
Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog
|
|
|
|
Image Credits
|
|
-------------
|
|
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
|
|
|
|
[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
|
|
|
|
[Pickaface](http://pickaface.net/)
|
|
|
|
[Unsplash](https://unsplash.com/)
|
|
|
|
[Uifaces](http://uifaces.com/)
|