userfrosting/sprinkle-core

Core module for UserFrosting.

Fund package maintenance!
Open Collective
Ko Fi

Installs: 9 026

Dependents: 8

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 0

Open Issues: 1

Type:userfrosting-sprinkle


README

Version PHP Version License Build Codecov StyleCI PHPStan Join the chat Donate Donate

By Alex Weissman and Louis Charette

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

UserFrosting is a secure, modern user management system written in PHP and built on top of the Slim Microframework, Twig templating engine, and Eloquent 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 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

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 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.