2021-02-14 14:27:47 +01:00
# Contributing to AdminLTE
2020-12-07 08:06:46 +01:00
Contributions are always **welcome and recommended** ! Here is how for beginner's: [Get started with open source click here ](https://youtu.be/GbqSvJs-6W4 )
2021-02-14 14:27:47 +01:00
1. 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.
2020-12-07 08:06:46 +01:00
* 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
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
* Create a new branch
3. Compile dist files (Development) :
* To compile the dist files you need Node.js 10 or higher/npm (node package manager)
* Delete ./package-lock.json file
* `npm install` (install npm deps)
* `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
* 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)
4. Create a pull request
2021-02-14 14:27:47 +01:00
## Online one-click setup for contributing
2020-12-07 08:06:46 +01:00
You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically:
- clone the `AdminLTE` repo.
- install the dependencies.
2021-02-14 14:27:47 +01:00
- run `npm run dev` to start the server.
2020-12-07 08:06:46 +01:00
[![Open in Gitpod ](https://gitpod.io/button/open-in-gitpod.svg )](https://gitpod.io/from-referrer/)