https://github.com/userfrosting/sprinkle-core
The 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.
https://github.com/userfrosting/sprinkle-core
php userfrosting userfrosting-sprinkle
Last synced: about 1 month ago
JSON representation
The 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.
- Host: GitHub
- URL: https://github.com/userfrosting/sprinkle-core
- Owner: userfrosting
- License: other
- Created: 2021-05-31T02:19:27.000Z (almost 4 years ago)
- Default Branch: 5.1
- Last Pushed: 2024-10-29T23:53:38.000Z (7 months ago)
- Last Synced: 2024-10-30T01:54:43.312Z (7 months ago)
- Topics: php, userfrosting, userfrosting-sprinkle
- Language: PHP
- Homepage: https://www.userfrosting.com/
- Size: 6.94 MB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UserFrosting 5.1 Core Sprinkle
[](https://github.com/userfrosting/sprinkle-core/releases)
[](LICENSE.md)
[](https://github.com/userfrosting/sprinkle-core/actions)
[](https://app.codecov.io/gh/userfrosting/sprinkle-core/branch/5.1)
[](https://github.styleci.io/repos/372359383)
[](https://github.com/userfrosting/sprinkle-core/actions/workflows/PHPStan.yml)
[](https://chat.userfrosting.com)
[](https://opencollective.com/userfrosting#backer)
[](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/.github/blob/main/.github/CONTRIBUTING.md) as well as our [style guidelines](https://github.com/userfrosting/.github/blob/main/.github/STYLE-GUIDE.md).
[](https://github.com/userfrosting/sprinkle-core/graphs/contributors)