Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bengoruser/userbundle

Symfony bundle built on top of BenGorUser library
https://github.com/bengoruser/userbundle

ddd domain-driven-design php symfony-bundle user-management

Last synced: 4 days ago
JSON representation

Symfony bundle built on top of BenGorUser library

Awesome Lists containing this project

README

        

# BenGorUserBundle
> Fully featured and test covered user Symfony bundle built on top of [BenGorUser][6] library

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/5a2ac745-59f8-47b9-806a-6d1f4f9c96a6/mini.png)](https://insight.sensiolabs.com/projects/5a2ac745-59f8-47b9-806a-6d1f4f9c96a6)
[![Build Status](https://travis-ci.org/BenGorUser/UserBundle.svg?branch=master)](https://travis-ci.org/BenGorUser/UserBundle)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/BenGorUser/UserBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/BenGorUser/UserBundle/?branch=master)
[![Total Downloads](https://poser.pugx.org/bengor-user/user-bundle/downloads)](https://packagist.org/packages/bengor-user/user-bundle)
[![Latest Stable Version](https://poser.pugx.org/bengor-user/user-bundle/v/stable.svg)](https://packagist.org/packages/bengor-user/user-bundle)
[![Latest Unstable Version](https://poser.pugx.org/bengor-user/user-bundle/v/unstable.svg)](https://packagist.org/packages/bengor-user/user-bundle)

Following the [basic configuration guide](docs/basic_configuration.md), in 2 minutes you will have the following
fully tested **multiple user type** and **multiple renderers** (HTML / JSON) features in your Symfony application:

* User registration
* Basic
* With confirmation
* By invitation
* Change password
* Basic
* Without old password
* Using Remember password
* Log in / log out
* JWT authentication
* User removal
* Role management
* Grant
* Revoke
* Purge outdated tokens
* Invitation token
* Remember password token

## Requirements
PHP >= 5.5
Symfony >= 2.8

## Documentation

All the documentation is stored in the `docs` folder.

[Show me the docs!](docs/index.md)

## Tests
This bundle is completely tested by **[PHPSpec][1], SpecBDD framework for PHP**.

In case you want to contribute or just run the tests, use the following command.
```bash
$ vendor/bin/phpspec run -fpretty
```

## Contributing
If you have any doubt or maybe you want to share some opinion, you can use our **Gitter** chat.

[![Join the chat at https://gitter.im/BenGorUser/User](https://badges.gitter.im/BenGorUser/User.svg)](https://gitter.im/BenGorUser/User?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

BenGorUser uses [Crowdin][8] as tool to manage translations so, please help us translating your favorite language
via this service. Pull requests about translations will not be accepted.

[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bengoruser/localized.svg)](https://crowdin.com/project/bengoruser)

This bundle follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][5].
Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order
to simplify we provide a Composer script that wraps all the commands related with this process.
```bash
$ composer run-script cs
```

There is also a policy for contributing to this project. Pull requests must be explained step by step to make the
review process easy in order to accept and merge them. New methods or code improvements must come paired with
[PHPSpec][1] tests.

If you would like to contribute it is a good point to follow Symfony contribution standards, so please read the
[Contributing Code][2] in the project documentation. If you are submitting a pull request, please follow the guidelines
in the [Submitting a Patch][3] section and use the [Pull Request Template][4].

## Credits
This bundle is created by:
>
**@benatespina** - [[email protected]](mailto:[email protected])

**@gorkalaucirica** - [[email protected]](mailto:[email protected])

## Licensing Options
[![License](https://poser.pugx.org/bengor-user/user-bundle/license.svg)](https://github.com/BenGorUser/UserBundle/blob/master/LICENSE)

[1]: http://www.phpspec.net/
[2]: http://symfony.com/doc/current/contributing/code/index.html
[3]: http://symfony.com/doc/current/contributing/code/patches.html#check-list
[4]: http://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request
[5]: http://cs.sensiolabs.org/
[6]: https://github.com/BenGorUser/User
[7]: http://getcomposer.org
[8]: https://crowdin.com/