/yii2-user

Yii2 user registration and authentication module

Primary LanguagePHPMIT LicenseMIT

Yii2-User

Gratipay User Dependency Status Code Climate Latest Stable Version Total Downloads Latest Unstable Version

Yii2-User provides a web interface for advanced access control, user management and includes following features:

NOTE: Module is not yet in alpha version. Use it on your own risk. Some features are missing. Anything can be changed at any time.

Works only with Yii2 app advanced startup kit

  • Configurable Settings
    • Account(Login, Register, Password Reset, Password Recovery etc.)
    • Profile
    • Admin
  • Notification Settings
  • Ability to upload avatar
  • Rbac Implementation
  • Configurable Widgets
  • All settings configurable via GUI

Documentation

Installation

This document will guide you through the process of installing Yii2-User using composer.

Add Yii2-User to the require section of your composer.json file:

{
    "require": {
        "abhi1693/yii2-user": "*"
    }
}

And run following command to download extension using composer:

$ composer update

Configuration

To enable module you should configure your application as follows:

		'modules'    => [
		...
			'user'      => [
				'class'  => \abhimanyu\user\UserModule::className(),
			],
        ],
		'components' => [
		...
			'user'       => [
				'identityClass' => \abhimanyu\user\models\UserIdentity::className(),
				'loginUrl'      => ['/user/auth/login'],
			],
		],

Updating database schema

Run application Self-Test to update the database.

Why feature X is missing?

Because it is not implemented yet or will never be implemented. Check out roadmap.

How to contribute?

Contributing instructions are located in CONTRIBUTING.md file.

Roadmap

  • User Registration
  • Password Retrieval
  • Account Management
  • Profile Management
  • Console Commands
  • User Management Interface
  • Documentation
  • Compatibility with MySQL
  • Compatibility with other databases
  • Compatibility with other templates

Change Log

Refer to Change Logs

License

Yii2-user is released under the MIT License. See the bundled LICENSE for details.