An open API service indexing awesome lists of open source software.

https://github.com/userfrosting/extend-user

Example sprinkle for extending the User class to contain additional fields
https://github.com/userfrosting/extend-user

userfrosting userfrosting-sprinkle

Last synced: about 1 month ago
JSON representation

Example sprinkle for extending the User class to contain additional fields

Awesome Lists containing this project

README

        

# User Extension Sprinkle (UserFrosting 5)

[![Version](https://img.shields.io/github/v/release/userfrosting/extend-user?include_prereleases)](https://github.com/userfrosting/extend-user/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/extend-user/Build.yml?branch=5.0&logo=github)](https://github.com/userfrosting/extend-user/actions)
[![Codecov](https://codecov.io/gh/userfrosting/extend-user/branch/5.0/graph/badge.svg)](https://app.codecov.io/gh/userfrosting/extend-user/branch/5.0)
[![StyleCI](https://github.styleci.io/repos/372359383/shield?branch=5.0&style=flat)](https://github.styleci.io/repos/372359383)
[![PHPStan](https://img.shields.io/github/actions/workflow/status/userfrosting/extend-user/PHPStan.yml?branch=5.0&label=PHPStan)](https://github.com/userfrosting/extend-user/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)

Example sprinkle for extending the User class to contain additional fields. [See the learn documentation for more information](https://learn.userfrosting.com/recipes/extending-the-user-model).

# Installation

This sprinkle/example can be installed like any UserFrosting application or skeleton. See the [installation guide](https://learn.userfrosting.com/installation) for the required config and more info on the installation steps.

## Quick start

```bash
git clone https://github.com/userfrosting/extend-user.git
cd extend-user
composer install
php bakery bake
php bakery serve
```

You can now access UserFrosting at : http://localhost:8080

## Docker

To run inside docker :
```bash
git clone https://github.com/userfrosting/extend-user.git
cd extend-user
docker-compose build --no-cache
docker-compose up -d
docker-compose exec app composer install
docker-compose exec app php bakery bake
```

You can now access UserFrosting at : http://localhost:8080

## Documentation
- [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://opencollective.com/userfrosting/contributors.svg?width=890&button=true)](https://github.com/userfrosting/sprinkle-core/graphs/contributors)