AdminLTE/README.md

96 lines
3.1 KiB
Markdown
Raw Normal View History

2015-02-22 19:12:01 +00:00
Introduction
============
2014-10-31 01:31:01 +00:00
2018-03-17 17:07:55 +00:00
**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.
2014-02-01 16:15:26 +00:00
2018-02-03 23:45:19 +00:00
**Download & Preview on [AdminLTE.io](https://adminlte.io)**
2015-02-22 19:12:01 +00:00
Looking for Premium Templates?
2015-02-23 00:59:19 +00:00
------------------------------
2018-03-17 17:07:55 +00:00
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.
2014-02-01 19:18:02 +00:00
2018-03-17 17:11:26 +00:00
!["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation")
2014-02-01 16:15:26 +00:00
2018-03-17 17:07:55 +00: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 16:15:26 +00:00
2015-02-22 19:12:01 +00:00
Installation
2015-02-23 00:59:19 +00:00
------------
2015-02-22 19:12:01 +00:00
There are multiple ways to install AdminLTE.
2018-03-17 17:07:55 +00:00
#### Download:
2015-02-23 00:59:19 +00:00
2018-02-03 23:45:19 +00:00
Download from Github or [visit AdminLTE.io](https://adminlte.io) and download the latest release.
2015-02-22 19:12:01 +00:00
2018-03-17 17:07:55 +00:00
#### Using The Command Line:
2015-02-22 19:12:01 +00:00
2018-03-17 17:07:55 +00:00
**NPM**
```bash
npm install admin-lte
2015-02-22 19:15:19 +00:00
```
2015-02-22 19:12:01 +00:00
2018-03-17 17:07:55 +00:00
**Github**
2015-02-22 19:12:01 +00:00
2018-03-17 17:07:55 +00:00
- Clone to your machine
2015-02-22 19:15:19 +00:00
```
git clone https://github.com/ColorlibHQ/AdminLTE.git
2015-02-22 19:15:19 +00:00
```
2015-02-22 19:12:01 +00:00
Documentation
2015-02-23 00:59:19 +00:00
-------------
2018-02-03 23:45:19 +00:00
Visit the [online documentation](https://adminlte.io/themes/AdminLTE/documentation/index.html) for the most
2015-02-22 19:12:01 +00:00
updated guide. Information will be added on a weekly basis.
Browser Support
2015-02-23 00:59:19 +00:00
---------------
2018-03-17 17:07:55 +00:00
- IE 10+
2015-02-22 19:12:01 +00:00
- Firefox (latest)
- Chrome (latest)
- Safari (latest)
- Opera (latest)
Contribution
2015-02-23 00:59:19 +00:00
------------
2015-02-22 19:12:01 +00:00
Contribution are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
2015-03-04 16:12:30 +00:00
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
2018-03-17 17:07:55 +00:00
- Create a new branch
2015-02-22 19:12:01 +00:00
- Make your changes
- Create a pull request
2015-02-23 00:59:19 +00:00
#### Contribution Requirements:
2018-02-03 23:45:19 +00:00
- 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.
2015-02-22 19:12:01 +00:00
- 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
2015-02-23 00:59:19 +00:00
-------
2018-02-03 23:45:19 +00:00
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](http://opensource.org/licenses/MIT). AdminLTE.io
2015-02-22 19:12:01 +00:00
reserves the right to change the license of future releases.
2018-03-17 17:07:55 +00:00
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)
2015-02-23 00:55:00 +00:00
2015-02-22 19:12:01 +00:00
Change log
2015-02-23 00:59:19 +00:00
----------
Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog
2014-04-06 00:12:30 +00:00
2015-02-22 19:12:01 +00:00
Image Credits
2015-02-23 00:59:19 +00:00
-------------
2015-02-22 19:12:01 +00:00
[Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
[Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
2014-02-01 16:15:26 +00:00
2015-02-22 19:12:01 +00:00
[Pickaface](http://pickaface.net/)
2014-02-01 16:15:26 +00:00
2015-02-22 19:12:01 +00:00
[Unsplash](https://unsplash.com/)
2014-02-01 16:15:26 +00:00
2015-02-28 02:20:59 +00:00
[Uifaces](http://uifaces.com/)