Skip to content
/ sprinkle-admin Public

README.md

Latest commit

 

History

History
70 lines (54 loc) · 3.56 KB

README.md

File metadata and controls

70 lines (54 loc) · 3.56 KB
Raw

UserFrosting 6.0 - Admin Sprinkle

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 Admin sprinkle contains the routes and controllers to implement the administrative user management interface, as well as the group, role, and permission management interfaces.

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

  2. Add the Sprinkle to your Sprinkle Recipe :

    public function getSprinkles(): array
{
    return [
        \UserFrosting\Sprinkle\Admin\Admin::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.