Spur.us Monocle

🤖 Simple and easy Spur.us Monocle integration with Nuxt.js

📖 Release Notes

Setup

1. Add nuxt-monocle dependency with yarn or npm into your project
2. Add nuxt-monocle to modules section of nuxt.config.js
3. Configure it:

{
  modules: [
    [
      'nuxt-monocle', {
        /* Monocle options */
      }
    ],
  ]
}

using top level options

{
  modules: [
    'nuxt-monocle',
  ],

  monocle: {
    /* Monocle options */
  },
}

Configuration

{
  // ...
  monocle: {
    token: String, // Token for requests
  },
  // ...
}

Runtime config

// nuxt.config.js
export default {
  publicRuntimeConfig: {
    monocle: {
      /* Monocle options */
      token: process.env.MONOCLE_TOKEN // for example
    }
  }
}

Generate Monocle Token

You can generate token by registering a new account.

Usage

Monocle

1. Add <monocle> component inside your component:

<template>
  <monocle />
  <button @click="verifyAnonMode">Clic me</button>
</template>

2. Call getBundle to get Monocle bundle and send it to the server:

async verifyAnonMode() {
  try {
    const bundle = await this.$monocle.getBundle()
    console.log('Monocle bundle:', bundle)

    // send bundle to server alongside your form data

    // at the end you need to refresh monocle
    await this.$monocle.refresh()
  } catch (error) {
    console.log('error:', error)
  }
},

3. Call destroy function inside beforeDestroy hook of the page. (This will remove Monocle scripts, styles and badge from the page)

beforeDestroy() {
  this.$monocle.destroy()
}

See:

• example

Server Side

When you send data + bundle to the server, you should verify the bundle on the server side to make sure it does not requested from a anon network. You can find out how to verify bundle on the server side by looking at the server controller inside example.

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev

License

MIT License

Copyright (c) owapp [email protected]