userfrosting/sprinkle-core

Core module for UserFrosting.

Maintainers

Package info

github.com/userfrosting/sprinkle-core

Homepage

Type:userfrosting-sprinkle

pkg:composer/userfrosting/sprinkle-core

Statistics

Installs: 37 842

Dependents: 12

Suggesters: 0

Stars: 0


README

Warning

Since 6.0, this is a read-only subtree split of the UserFrosting Monorepo. To contribute, all Issues and Pull Requests should be sent against the monorepo. Please see the contributing guidelines for more information.

By Alex Weissman and Louis Charette

Copyright (c) 2013-2026, free to use in personal and commercial software as per the MIT license.

UserFrosting is a secure, modern user management system written in PHP and built on top of the Slim Microframework, Twig templating engine, Eloquent ORM, Vite, Vue, and UiKit.

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 project :

    composer require userfrosting/sprinkle-core
    
  2. Add the Sprinkle to your Sprinkle Recipe :

    public function getSprinkles(): array
    {
        return [
            \UserFrosting\Sprinkle\Core\Core::class,
        ];
    }
  3. Bake

    php bakery bake

Documentation

See main UserFrosting Documentation for more information.

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 as well as our style guidelines.