maxmustermann/AdminLTE
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md (#3118)

Browse source 
Co-authored-by: REJack <info@rejack.de>
This commit is contained in:
Daniel 2020-11-25 12:23:27 +05:30 committed by GitHub
parent dfdb0f0665
commit 5d10674dc5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -5,7 +5,7 @@
[![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte) [![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4.4](https://getbootstrap.com/)** framework and also the JS/jQuery plugin. **AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4.5](https://getbootstrap.com/)** framework and also the JS/jQuery plugin.
Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops.
**Preview on [AdminLTE.io](https://adminlte.io/themes/v3)** **Preview on [AdminLTE.io](https://adminlte.io/themes/v3)**
@ -24,9 +24,11 @@ SCSS has been used to increase code customizability.
There are multiple ways to install AdminLTE. There are multiple ways to install AdminLTE.
### Download: ### Download & Changelog:
Download from [GitHub releases](https://github.com/ColorlibHQ/AdminLTE/releases). Download from GitHub latest release [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/latest).
Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog.
Legacy Releases are [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1).
### Using The Command Line: ### Using The Command Line:
@ -63,37 +65,38 @@ _**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or
Visit the [online documentation](https://adminlte.io/docs/3.0/) for the most Visit the [online documentation](https://adminlte.io/docs/3.0/) for the most
updated guide. Information will be added on a weekly basis. updated guide. Information will be added on a weekly basis.
## Browser Support ## Browsers support
- IE 10+ | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png" alt="Samsung" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Samsung | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/vivaldi/vivaldi_48x48.png" alt="Vivaldi" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Vivaldi | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Electron |
- Firefox (latest) | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- |
- Chrome (latest) | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions
- Safari (latest)
- Opera (latest)
- Microsoft Edge (latest)
## Contributions ## How to Contribute
Contributions are always **welcome and recommended**! Here is how: Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4)
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). 1. Contribution Requirements :
- Clone to your machine * 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](https://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).
2. Installation :
* Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
* Clone to your machine
```bash ```bash
git clone https://github.com/YOUR_USERNAME/AdminLTE.git git clone https://github.com/YOUR_USERNAME/AdminLTE.git
``` ```
* Create a new branch
- Create a new branch 3. Compile dist files (Development) :
- Make your changes * To compile the dist files you need Node.js 10 or higher/npm (node package manager)
- Create a pull request * Delete ./package-lock.json file
* `npm install` (install npm deps)
### Compile dist files * `npm run dev` (developer mode, autocompile with browsersync support for live demo)
* Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
To compile the dist files you need Node.js/npm, clone/download the repo then: * Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
* `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request)
1. `npm install` (install npm deps) 4. Create a pull request
2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
3. `npm run production` (compile css/js files)
### Online one-click setup for contributing ### Online one-click setup for contributing
@ -105,31 +108,19 @@ You can use Gitpod(an online IDE which is free for Open Source) for working on i
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
### Contribution Requirements: ### Compile dist files
- 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. To compile the dist files you need Node.js/npm, clone/download the repo then:
- If you use content provided by another party, it must be appropriately licensed using an [open source](https://opensource.org/licenses) license.
- Contributions are only accepted through GitHub pull requests. 1. `npm install` (install npm deps)
- Finally, contributed code must work in all supported browsers (see above for browser support). 2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo)
3. `npm run production` (compile css/js files)
## License ## License
AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT). 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. AdminLTE.io reserves the right to change the license of future releases.
## Latest Release
- [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/releases/latest)
## Legacy Releases
- [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18)
- [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1)
## Changelog
Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog
## Image Credits ## Image Credits
- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd) - [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)