https://github.com/bitfumes/laravel-breezer

https://github.com/bitfumes/laravel-breezer

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bitfumes/laravel-breezer
• Owner: bitfumes
• License: mit
• Created: 2021-09-11T20:22:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-20T03:05:32.000Z (about 2 years ago)
• Last Synced: 2025-01-16T02:21:57.999Z (4 months ago)
• Language: PHP
• Size: 65.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# breezer

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![GitHub issues](https://img.shields.io/github/issues/bitfumes/laravel-breezer)](https://github.com/bitfumes/laravel-breezer/issues)

[![Total Downloads](https://img.shields.io/packagist/dt/bitfumes/breezer.svg?style=flat-square)](https://packagist.org/packages/bitfumes/breezer)

[![Build Status](https://travis-ci.org/bitfumes/laravel-breezer.svg?branch=master)](https://travis-ci.org/bitfumes/laravel-breezer)

# Install

`composer require bitfumes/laravel-breezer`

# Steps to follow

## Steps 1

1. Add `Breezer` trait to your user model.

2. Add Contract `MustVerifyEmail` to your authenticatable model if you want to enable email verification.

```php

use Bitfumes\Breezer\Traits\Breezer;

use Illuminate\Contracts\Auth\MustVerifyEmail;

class User extends Authenticatable implements MustVerifyEmail

{

    use Notifiable, Breezer;

    ...

}

```

## Step 2

Now publish two new migrations

1.  To add avatar field to your use model.

2.  To add social login profile.

```bash

php artisan vendor:publish --tag=breezer:migrations

```

## Step 3

After getting migrations in your laravel application, its time to have these tables in your database.

```bash

php artisan migrate

```

## Step 4

Set your frontend URL on your .env file

FRONT_URL

Set frontend Verify Email URL  on your .env file

BREEZER_VERIFY_URL

Set frontend password reset URL  on your .env file

BREEZER_RESET_URL

## Step 5

Because every user need to verify its email and to send email we are going to use laravel queue.

Now add queue driver on your `.env` file

That's it, now enjoy api auth with JWT

```

QUEUE_DRIVER=database

```

## Testing

Run the tests with:

```bash

vendor/bin/phpunit

```

## 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.

## License

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