]>
Commit | Line | Data |
---|---|---|
31f18b77 FG |
1 | Introduction |
2 | ============ | |
3 | ||
4 | ![Bower version](https://img.shields.io/bower/v/adminlte.svg) | |
5 | [![npm version](https://img.shields.io/npm/v/admin-lte.svg)](https://www.npmjs.com/package/admin-lte) | |
6 | [![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte) | |
7 | ||
8 | **AdminLTE** -- is a fully responsive admin template. Based on **[Bootstrap 3](https://github.com/twbs/bootstrap)** framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. Check out the live preview now and see for yourself. | |
9 | ||
10 | **Download & Preview on [Almsaeed Studio](https://almsaeedstudio.com)** | |
11 | ||
12 | Looking for Premium Templates? | |
13 | ------------------------------ | |
14 | **Almsaeed studio just opened a new premium templates page. Hand picked to insure the best quality and the most affordable prices. Visit https://almsaeedstudio.com/premium for more information.** | |
15 | ||
16 | ||
17 | !["AdminLTE Presentation"] (https://almsaeedstudio.com/AdminLTE2.png "AdminLTE Presentation") | |
18 | ||
19 | **AdminLTE** has been carefully coded with clear comments in all of its JS, LESS and HTML files. LESS has been used to increase code customizability. | |
20 | ||
21 | Installation | |
22 | ------------ | |
23 | There are multiple ways to install AdminLTE. | |
24 | ||
25 | ####Download: | |
26 | ||
27 | Download from Github or [visit Almsaeed Studio](https://almsaeedstudio.com) and download the latest release. | |
28 | ||
29 | ####Using The Command Line: | |
30 | ||
31 | **Github** | |
32 | ||
33 | - Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). | |
34 | - Clone to your machine | |
35 | ``` | |
36 | git clone https://github.com/YOUR_USERNAME/AdminLTE.git | |
37 | ``` | |
38 | ||
39 | **Bower** | |
40 | ||
41 | ``` | |
42 | bower install admin-lte | |
43 | ``` | |
44 | ||
45 | **npm** | |
46 | ||
47 | ``` | |
48 | npm install --save admin-lte | |
49 | ``` | |
50 | ||
51 | **Composer** | |
52 | ||
53 | ``` | |
54 | composer require "almasaeed2010/adminlte=~2.0" | |
55 | ``` | |
56 | ||
57 | Documentation | |
58 | ------------- | |
59 | Visit the [online documentation](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html) for the most | |
60 | updated guide. Information will be added on a weekly basis. | |
61 | ||
62 | Browser Support | |
63 | --------------- | |
64 | - IE 9+ | |
65 | - Firefox (latest) | |
66 | - Chrome (latest) | |
67 | - Safari (latest) | |
68 | - Opera (latest) | |
69 | ||
70 | Contribution | |
71 | ------------ | |
72 | Contribution are always **welcome and recommended**! Here is how: | |
73 | ||
74 | - Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). | |
75 | - Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git``` | |
76 | - Make your changes | |
77 | - Create a pull request | |
78 | ||
79 | #### Contribution Requirements: | |
80 | ||
81 | - When you contribute, you agree to give a non-exclusive license to Almsaeed Studio to use that contribution in any context as we (Almsaeed Studio) see appropriate. | |
82 | - If you use content provided by another party, it must be appropriately licensed using an [open source](http://opensource.org/licenses) license. | |
83 | - Contributions are only accepted through Github pull requests. | |
84 | - Finally, contributed code must work in all supported browsers (see above for browser support). | |
85 | ||
86 | License | |
87 | ------- | |
88 | AdminLTE is an open source project by [Almsaeed Studio](https://almsaeedstudio.com) that is licensed under [MIT](http://opensource.org/licenses/MIT). Almsaeed Studio | |
89 | reserves the right to change the license of future releases. | |
90 | ||
91 | Todo List | |
92 | --------- | |
93 | - ~~Light sidebar colors~~ (Done v2.1.0) | |
94 | - ~~Right sidebar~~ (Done v2.1.0) | |
95 | - ~~Minified main-sidebar~~ (Done v2.1.0) | |
96 | - Right to left support | |
97 | - ~~Custom pace style~~ (Done v2.3.1) | |
98 | ||
99 | Legacy Releases | |
100 | ---------------- | |
101 | AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#upgrade), but if you intend to keep using AdminLTE 1.x, you can download the latest release from the [releases](https://github.com/almasaeed2010/AdminLTE/releases) section above. | |
102 | ||
103 | Change log | |
104 | ---------- | |
105 | **For the most recent change log, visit the [releases page](https://github.com/almasaeed2010/AdminLTE/releases) or the [changelog file](https://github.com/almasaeed2010/AdminLTE/blob/master/changelog.md).** We will add a detailed release notes to each new release. | |
106 | ||
107 | Image Credits | |
108 | ------------- | |
109 | [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd) | |
110 | ||
111 | [Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/) | |
112 | ||
113 | [Pickaface](http://pickaface.net/) | |
114 | ||
115 | [Unsplash](https://unsplash.com/) | |
116 | ||
117 | [Uifaces](http://uifaces.com/) | |
118 | ||
119 | Donations | |
120 | --------- | |
121 | Donations are **greatly appreciated!** | |
122 | ||
123 | [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "AdminLTE Presentation")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=629XCUSXBHCBC "Donate") |