mkinyua53/laravel-inertia-boilerplate

Laravel Inertia boilerplate.

v0.3.0 2021-08-09 11:26 UTC

Requires

• php: ^7.3|^8.0
• doctrine/dbal: ^3.0
• fideloper/proxy: ^4.4
• fruitcake/laravel-cors: ^2.0
• guzzlehttp/guzzle: ^7.0.1
• inertiajs/inertia-laravel: ^0.4.3
• kreait/laravel-firebase: ^3.1
• larapacks/authorization: v2.3.1
• laravel-notification-channels/fcm: ~2.0
• laravel-notification-channels/webpush: ^5.1
• laravel/framework: ^8.12
• laravel/jetstream: ^1.6
• laravel/sanctum: ^2.6
• laravel/socialite: ^5.2
• laravel/tinker: ^2.5
• maatwebsite/excel: ^3.1
• tightenco/ziggy: ^0.9.4

Requires (Dev)

• barryvdh/laravel-ide-helper: ^2.9
• facade/ignition: ^2.5
• fakerphp/faker: ^1.9.1
• mockery/mockery: ^1.4.2
• nunomaduro/collision: ^5.0
• phpunit/phpunit: ^9.3.3

MIT

• laravel jetstream
• laravel webpush
• laravel service-worker
• laravel inertia

README

This is a laravel version 8 boilerplate. Included are:

• Laravel v8
• Jetstream with inertia stack
• VueJS
• Vuetify in place of TailWind even though TailWind compilation is included in laravel mix with a prefix in the class names
• WorkBox service worker
• Web Push notification

Other features

• Role-based authorization; Check app\Http\Controllers\AuthController
• Vue-meta

Installing

composer create-project mkinyua53/laravel-inertia-boilerplate myproject

Install dependencies

yarn

Run server

php artisan serve

Run watch

yarn watch

To generate the service worker run the production server

yarn prod

The service-worker is installed in the resources\js\bootstrap.js The Push notification is activated for logged-in users in resources\views\app.blade.php with this line

@auth
  <script defer async src="/js/push.js"></script>
@endauth

To ask for notification permission, in a .vue file, example in resources\js\Layouts\User.vue

export default {
  name: 'user-layout',
  metaInfo () {
    return {
      title: 'User Dashboard'
    }
  },
  data () {
    return {
      webpushsuccess: false,
      snackbar: false,
      message: ''
    }
  },
  methods: {
    turnonnotif () {
      if (!('Notification' in window)) {
        this.message = 'Your browser doesn\'t support Notifications'
        this.snackbar = true
        return
      }
      if (Notification.permission === 'denied') {
        this.message = 'You have explicitly denied notifications for this app. <br>Please reset notifications settings for this url ' + window.location.origin
        this.snackbar = true
      }
      //  Dispatched a custom event and listen for it to request notifications permission
      window.dispatchEvent(new CustomEvent('notifyme'));
    }
  },
  computed: {
    webpush () {
      return ('Notification' in window) && Notification.permission === 'granted'
    }
  },
  created () {
    var vm = this
    // we listen for this custom event fired after the notification subscription is saved in the server
    window.addEventListener('notifyon', function () {
      vm.webpushsuccess = true
    })
  },
  watch: {
    'webpushsuccess': function (value) {
      if (value) {
        this.message = 'Notifications turned on successfully'
        this.snackbar = true
      }
    }
  }

in push.js

if ('serviceWorker' in navigator) {
  const event = new Event('notifyme');
  window.addEventListener('notifyme', () => {
    if ("PushManager" in window) {
      navigator.serviceWorker.register('/service-worker.js')
        .then(() => {
          // console.log('serviceWorker installed!')
          initPush();
        })
        .catch((err) => {
          console.log(err)
        });
    }
  });
}

function storePushSubscription(pushSubscription) {
  const token = document.querySelector('meta[name=csrf-token]').getAttribute('content');

  fetch('/user/push', {
    method: 'POST',
    body: JSON.stringify(pushSubscription),
    headers: {
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'X-CSRF-Token': token
    }
  })
    .then((res) => {
      return res.json();
    })
    .then((res) => {
      // Dispatch a custom event
      const event = new Event('notifyon');
      window.dispatchEvent(event)
      console.log(res)
    })
    .catch((err) => {
      console.log(err)
    });
}

Alternatively, you can ask for permission on onload event and avoid using custom events, but, FireFox requires that the permission request be user initiated

if ('serviceWorker' in navigator) {
  window.addEventListener('load', () => {
    if ("PushManager" in window) {
      navigator.serviceWorker.register('/service-worker.js')
        .then(() => {
          // console.log('serviceWorker installed!')
          initPush();
        })
        .catch((err) => {
          console.log(err)
        });
    }
  });
}

Authorization front-end

<v-btn small v-if="can && can['dashboard.view]">View Dashboard</v-btn>

Credits

1. Sagar Maheshwary for the WebPush code