How To Contribute

Contributing to AdminLTE

Contributions are always welcome and recommended! Here is how for beginner’s: Get started with open source click here

  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.
    • If you use content provided by another party, it must be appropriately licensed using an open source 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 :

    git clone https://github.com/YOUR_USERNAME/AdminLTE.git
    • Create a new branch from master

  3. Compile dist files (Development) :

    • To compile the dist files you need Node.js 22.22.3+, 24.16.0+, or 26.3.0+ and npm 10+
    • npm ci (install the locked dependency tree)
    • npm run dev (developer mode, asset watchers and Astro live demo at http://localhost:3000)
    • Make your changes only in ./src Folder OR package.json in any files which are necessary for contribution
    • Do not make changes in ./dist/** Because it contains compiled files and do not include in PR (Pull Request)
    • npm test (unit tests), then npm run build and npm run test-browser / npm run test-a11y (install browsers with npx playwright install chromium)
    • npm run production (lint, run unit tests, compile assets, and check gzip budgets before creating a pull request)

  4. Create a pull request to master branch

Online one-click setup for contributing

You can use Codespace an online IDE which is free for Open Source for working on issues or making PRs (Pull Requests). With a single click it will launch a workspace and automatically:

  • clone the AdminLTE repo.
  • Open with Codespace or Open in Gitpod
  • install the dependencies.
  • run npm run dev to start the server.