squashjedi/basecamp

:package_description

Basecamp

, _(*1)

About Basecamp

Basecamp provides a great starting place for your Laravel project with all of the following:- * It has a fluent interface to OAuth authentication with Facebook using the Laravel Socialite package. * Built in emails to authenticate users, password resets, resend validation code and a welcome email. * An area for logged in users to update their settings. * A webmaster's admin panel to CRUD Users. * A Users API., _(*2)

Install

via Composer, _(*3)

``` bash composer require squashjedi/basecamp, <sub>(*4)</sub>

## Configuration

After installing the Basecamp library, register `Squashjedi\Basecamp\BasecampServiceProvider::class` in your `config/app.php` configuration file:

``` bash
'providers' => [
    // Other service providers...

    Squashjedi\Basecamp\BasecampServiceProvider::class,
],

You will also need to add credentials for the OAuth services your application utilises. These credentials should be placed in your config/services.php configuration file and should use the key facebook. For example:, <sub>(*5)</sub>

``` bash 'facebook' => [ 'client_id' => 'your-facebook-app-id', 'client_secret' => 'your-facebook-app-secret', 'redirect' => 'http://your-callback-url', ],, <sub>(*6)</sub>

Run the following commands:
``` bash
php artisan vendor:publish --tag=basecamp
php artisan migrate
php artisan db:seed --class="Squashjedi\\Basecamp\\DatabaseSeeder"
npm install
npm install font-awesome

Add these Vue components in resources/assets/js/app.js: ``` bash Vue.component('basecamp-pagination', require('./components/basecamp/Pagination.vue'));, <sub>(*7)</sub>

Vue.component('basecamp-notify', require('./components/basecamp/Notify.vue'));, <sub>(*8)</sub>

Vue.component('basecamp-modal-delete', require('./components/basecamp/ModalDelete.vue'));, <sub>(*9)</sub>

Vue.component('basecamp-admin-users', require('./components/basecamp/admin/users/Index.vue'));, <sub>(*10)</sub>

Vue.component('basecamp-admin-users-fields', require('./components/basecamp/admin/users/Fields.vue'));, <sub>(*11)</sub>

Vue.component('basecamp-admin-users-create', require('./components/basecamp/admin/users/Create.vue'));, <sub>(*12)</sub>

Vue.component('basecamp-admin-users-edit', require('./components/basecamp/admin/users/Edit.vue'));, <sub>(*13)</sub>

Vue.component('basecamp-user-settings-account', require('./components/basecamp/user/settings/account/Account.vue'));, <sub>(*14)</sub>

Vue.component('basecamp-user-settings-account-deactivate', require('./components/basecamp/user/settings/account/Deactivate.vue'));, <sub>(*15)</sub>

Vue.component('basecamp-user-settings-account-deactivate-modal', require('./components/basecamp/user/settings/account/DeactivateModal.vue'));, <sub>(*16)</sub>

Vue.component('basecamp-user-settings-password', require('./components/basecamp/user/settings/password/Password.vue'));, <sub>(*17)</sub>

Vue.component('basecamp-settings-password-forgot', require('./components/basecamp/user/settings/password/Forgot.vue'));, <sub>(*18)</sub>

Vue.component('basecamp-user-settings-password-reset', require('./components/basecamp/user/settings/password/Reset.vue'));, <sub>(*19)</sub>

Add these at the bottom of `resources/assets/sass/app.scss`:
``` bash
// Font Awesome
@import "node_modules/font-awesome/scss/font-awesome.scss";

// Basecamp variables
@import "basecamp/variables";

// Basecamp extras
@import "basecamp/extras";

Run the following command: ``` bash npm run dev, <sub>(*20)</sub>

Delete `resources/views/welcome.blade.php`.

Delete all routes in `routes/web.php`.

Replace `app/User.php` with:
``` bash
<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Squashjedi\Basecamp\App\Notifications\ResetPasswordNotification;
use Squashjedi\Basecamp\App\Social;
use Squashjedi\Basecamp\App\Role;
use Squashjedi\Basecamp\App\PasswordReset;
use Illuminate\Database\Eloquent\SoftDeletes;

class User extends Authenticatable
{
    use Notifiable, SoftDeletes;

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ['deleted_at'];

    /**
     * Send the password reset notification.
     *
     * @param  string  $token
     * @return void
     */
    public function sendPasswordResetNotification($token)
    {
        $this->notify(new ResetPasswordNotification($token));
    }

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'verified', 'name', 'email', 'password', 'verify_token', 'deleted_at'
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * Get the social networks for the user.
     */
    public function social()
    {
        return $this->hasMany(Social::class);
    }

    /**
     * Get the roles for the user.
     */
    public function roles()
    {
        return $this->hasMany(Role::class);
    }

    /**
     * Get the password code for the user.
     */
    public function passwordReset()
    {
        return $this->hasOne(PasswordReset::class, 'email', 'email');
    }
}

Add the following to resources/lang/en/validation.php: ``` bash return [ // Other error messages..., <sub>(*21)</sub>

'password_match'        => 'This doesn\'t match your current password',

];, <sub>(*22)</sub>

Install `Laravel Passport` https://packagist.org/packages/laravel/passport.

Add this middleware to `app/Http/Kernel`:
``` bash
protected $middlewareGroups = [
    'web' => [
        // Other middleware classes...

        \Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
    ],
];

Usage

The database seed creates 1000 users., <sub>(*23)</sub>

The webmaster's login details are: bash Email: me@example.com Password: 123456, <sub>(*24)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*25)</sub>