https://github.com/mawuva/laravel-user-feature-set

A set of feature related to users
https://github.com/mawuva/laravel-user-feature-set

Last synced: 7 days ago
JSON representation

A set of feature related to users

• Host: GitHub
• URL: https://github.com/mawuva/laravel-user-feature-set
• Owner: mawuva
• License: mit
• Created: 2022-11-19T04:29:44.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-19T04:32:33.000Z (almost 2 years ago)
• Last Synced: 2024-05-19T06:04:07.995Z (6 months ago)
• Language: PHP
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# User Feature Set - A set of feature related to users

[![Latest Version on Packagist](https://img.shields.io/packagist/v/mawuva/laravel-user-feature-set.svg?style=flat-square)](https://packagist.org/packages/mawuva/laravel-user-feature-set)

[![Total Downloads](https://img.shields.io/packagist/dt/mawuva/laravel-user-feature-set.svg?style=flat-square)](https://packagist.org/packages/mawuva/laravel-user-feature-set)

![GitHub Actions](https://github.com/mawuva/laravel-user-feature-set/actions/workflows/main.yml/badge.svg)

This packahe provide you with a set of features that you can use to enhance your work while working on the users management in your project.

## Installation

You can install the package via composer:

```bash

composer require mawuva/laravel-user-feature-set

```

## Usage

After installing the package, just run the following command:

```bash

php artisan user-feature-set:install

```

This command will install, setup and publish the package files in your project.

It will also add two users in your database with the following credentials:

```text

email: [email protected]

password: password

email: [email protected]

password: password

```

## Features

This package will provide you the following features:

```php

use Mawuva\UserFeatureSet\DataTransferObjects\StoreUserDTO;

use Mawuva\UserFeatureSet\Facades\UserFeatureSet;

$data = UserDTO::from([

    "name" => "Test",

    "first_name" => "Test",

    "email" => "[email protected]",

    "password" => "password",

])

// Create a new user

$user = UserFeatureSet::storeUserData($data);

// Update the existing user data

$user = UserFeatureSet::updateUserData($data);

// Check user credentials

$user = UserFeatureSet::checkUserCredentials("[email protected]");

// Change user password

$id = "1"

$user = UserFeatureSet::changeUserPassword($id, "password");

```

The table bellow show you the attributes that you can use in order to manipulate your user model.

| Attributes |

|----------|

| name |

| first_name |

| gender |

| email |

| password |

| phone_number |

| whatsapp_number |

| username |

| is_admin |

| has_agreed_with_policy_and_terms_at |

| last_login_at |

### Testing

```bash

composer test

```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

-   [Ephraïm Seddor](https://github.com/mawuva)

-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Laravel Package Boilerplate

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).