@userfrosting/sprinkle-core/README.md

Core Sprinkle for UserFrosting

# UserFrosting 5.2 Core Sprinkle

[![Version](https://img.shields.io/github/v/release/userfrosting/sprinkle-core?include_prereleases)](https://github.com/userfrosting/sprinkle-core/releases)
![PHP Version](https://img.shields.io/badge/php-%5E8.1-brightgreen)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)
[![Build](https://img.shields.io/github/actions/workflow/status/userfrosting/sprinkle-core/Build.yml?branch=5.2&logo=github)](https://github.com/userfrosting/sprinkle-core/actions)
[![Codecov](https://codecov.io/gh/userfrosting/sprinkle-core/branch/5.2/graph/badge.svg)](https://app.codecov.io/gh/userfrosting/sprinkle-core/branch/5.2)
[![StyleCI](https://github.styleci.io/repos/372359383/shield?branch=5.2&style=flat)](https://github.styleci.io/repos/372359383)
[![PHPStan](https://img.shields.io/github/actions/workflow/status/userfrosting/sprinkle-core/PHPStan.yml?branch=5.2&label=PHPStan)](https://github.com/userfrosting/sprinkle-core/actions/workflows/PHPStan.yml)
[![Join the chat](https://img.shields.io/badge/Chat-UserFrosting-brightgreen?logo=Rocket.Chat)](https://chat.userfrosting.com)
[![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.

This **Core Sprinkle** provides most of the "heavy lifting" PHP code. It provides all the necessary services for database, templating, error handling, mail support, request throttling, and more.

## Installation in your UserFrosting project
To use this sprinkle in your UserFrosting project, follow theses instructions (*N.B.: This sprinkle is enabled by default when using the base app template*).

1. Require in your [UserFrosting](https://github.com/userfrosting/UserFrosting) project : 
    ```
    composer require userfrosting/sprinkle-core
    ```

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

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

## Install locally and run tests
You can also install this sprinkle locally. This can be useful to debug or contribute to this sprinkle. 

1. Clone repo :
    ```
    git clone https://github.com/userfrosting/sprinkle-core.git
    ```
2. Change directory
    ```
    cd sprinkle-core
    ```
3. Install dependencies :
    ```
    composer install
    ```
4. Run bake command :
    ```
    php bakery bake
    ```

From this point, you can use the same command as with any other sprinkle. 

Tests can be run using the bundled PHPUnit :
```
vendor/bin/phpunit
```

Same for PHPStan, for code quality :
```
vendor/bin/phpstan analyse app/src/
```

## 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/UserFrosting/blob/5.2/.github/CONTRIBUTING.md) as well as our [style guidelines](.github/STYLE-GUIDE.md).

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