Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 2.33 KB

installation.md

File metadata and controls

109 lines (85 loc) · 2.33 KB

Installation

Install dependency

Via yarn

yarn add @mspiderv/vuejwtauth

Via npm

npm install @mspiderv/vuejwtauth --save

Update your application code

In order to use this library, you need to create a new instance of VueJwtAuth class and pass an object with these properties as the only constructor argument:

  • Vue - Vue class (required argument)
  • router - Your VueRouter instance (required argument)
  • store - Your Vuex instance (optional argument)
  • options - Options object (optional argument)

Example in Vue.js application

Add the following code to your src/main.js.

import { VueJwtAuth, AxiosHttpDriver } from '@mspiderv/vuejwtauth'

new VueJwtAuth({
  Vue, // required
  router, // required
  store, // optional
  options: { // optional
    drivers: {
      http: new AxiosHttpDriver({
        // Your API URL here
        apiBaseURL: 'http://127.0.0.1:3000/api/'
      })
    }
  }
})

The result src/main.js can looks like this.

import Vue from 'vue'
import App from './App.vue'
import router from './router'
import store from './store'

import { VueJwtAuth, AxiosHttpDriver } from '@mspiderv/vuejwtauth'

Vue.config.productionTip = false

new VueJwtAuth({
  Vue, // required
  router, // required
  store, // optional
  options: { // optional
    drivers: {
      http: new AxiosHttpDriver({
        // Your API URL here
        apiBaseURL: 'http://127.0.0.1:3000/api/'
      })
    }
  }
})

new Vue({
  router,
  store,
  render: h => h(App)
}).$mount('#app')

Example in Quasar (v1.0.x) application

Create an empty boot file first.

$ quasar new boot auth

Fill the created file src/boot/auth.js with the following content

import { VueJwtAuth, AxiosHttpDriver } from '@mspiderv/vuejwtauth'

export default ({ Vue, store, router }) => new VueJwtAuth({
  Vue,
  router,
  store,
  options: { // optional
    drivers: {
      http: new AxiosHttpDriver({
        // Your API URL here
        apiBaseURL: 'http://127.0.0.1:3000/api/'
      })
    }
  }
})

Note: You need to append 'auth' string into boot array in quasar.conf.js file. The 'auth' boot file should be booted after the 'axios'.

Continue reading to Usage