@userfrosting/theme-adminlte/README.md

Admin LTE Theme for UserFrosting 5

# AdminLTE Theme for UserFrosting 5.1

[![Version](https://img.shields.io/github/v/release/userfrosting/theme-adminlte?sort=semver)](https://github.com/userfrosting/theme-adminlte/releases)
[![NPM Version](https://img.shields.io/npm/v/%40userfrosting%2Ftheme-adminlte)](https://www.npmjs.com/package/@userfrosting/theme-adminlte)
![PHP Version](https://img.shields.io/badge/php-%5E8.1-brightgreen)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
[![Build](https://img.shields.io/github/actions/workflow/status/userfrosting/theme-adminlte/Build.yml?branch=5.1&logo=github)](https://github.com/userfrosting/theme-adminlte/actions)
[![Codecov](https://codecov.io/gh/userfrosting/theme-adminlte/branch/5.1/graph/badge.svg)](https://app.codecov.io/gh/userfrosting/theme-adminlte/branch/5.1)
[![StyleCI](https://github.styleci.io/repos/445386142/shield?branch=5.1&style=flat)](https://github.styleci.io/repos/445386142)
[![PHPStan](https://img.shields.io/github/actions/workflow/status/userfrosting/theme-adminlte/PHPStan.yml?branch=5.1&label=PHPStan)](https://github.com/userfrosting/theme-adminlte/actions/workflows/PHPStan.yml)
[![Donate](https://img.shields.io/badge/Open_Collective-Donate-blue?logo=Open%20Collective)](https://opencollective.com/userfrosting#backer)
[![Donate](https://img.shields.io/badge/Ko--fi-Donate-blue?logo=ko-fi&logoColor=white)](https://ko-fi.com/lcharette)

## By [Alex Weissman](https://alexanderweissman.com) and [Louis Charette](https://bbqsoftwares.com)

Copyright (c) 2013-2024, free to use in personal and commercial software as per the [license](LICENSE.md).

UserFrosting is a secure, modern user management system written in PHP and built on top of the [Slim Microframework](http://www.slimframework.com/), [Twig](http://twig.sensiolabs.org/) templating engine, and [Eloquent](https://laravel.com/docs/10.x/eloquent#introduction) ORM.

The AdminLTE theme sprinkle contains all the twig files and frontend asset to implement the [AdminLTE template](https://adminlte.io/).

## Installation
1. Require in your [UserFrosting](https://github.com/userfrosting/UserFrosting) project : 
    ``` 
    composer require userfrosting/theme-adminlte
    ```

2. Add the Sprinkle to your Sprinkle Recipe : 
    ```php
    public function getSprinkles(): array
    {
        return [
            \UserFrosting\Theme\AdminLTE\AdminLTE::class,
        ];
    }
    ```

3. Bake
    ```bash
    php bakery bake
    ```

## Documentation
See main [UserFrosting Documentation](https://learn.userfrosting.com) for more information.

- [Changelog](CHANGELOG.md)
- [Issues](https://github.com/userfrosting/UserFrosting/issues)
- [License](LICENSE.md)
- [Style Guide](https://github.com/userfrosting/.github/blob/main/.github/STYLE-GUIDE.md)

## Contributing

This project exists thanks to all the people who contribute. If you're interested in contributing to the UserFrosting codebase, please see our [contributing guidelines](https://github.com/userfrosting/.github/blob/main/.github/CONTRIBUTING.md) as well as our [style guidelines](https://github.com/userfrosting/.github/blob/main/.github/STYLE-GUIDE.md).

[![](https://opencollective.com/userfrosting/contributors.svg?width=890&button=true)](https://github.com/userfrosting/sprinkle-core/graphs/contributors)