@nuxtjs/ngrok

ngrok exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes

Usage no npm install needed!

<script type="module">
  import nuxtjsNgrok from 'https://cdn.skypack.dev/@nuxtjs/ngrok';
</script>

README

@nuxtjs/ngrok

@nuxtjs/ngrok

npm version npm downloads Github Actions CI Codecov License

ngrok integration for NuxtJS

Features

  • Secure https for all tunnels
  • Show your work to anyone
  • Use the API to test web hooks
  • Test your UI in cloud browsers

📖  Read more

Quick Setup

  1. Add @nuxtjs/ngrok dependency to your project
yarn add @nuxtjs/ngrok # or npm install @nuxtjs/ngrok
  1. Add @nuxtjs/ngrok to the buildModules section of nuxt.config.js (or modules if on Nuxt < 2.9>)
{
  buildModules: [
    '@nuxtjs/ngrok',
  ],
}

Add Options

Add authorization and more using the module options.

ngrok: {
    // module options
    authtoken: 'my-ngrok-authtoken'
    auth: 'my-user:my-pwd',
    region: 'eu',
    addr: 8080,
    proto: 'http',
    subdomain: 'my-subdomain'
  }

See module options.

Usage

Run the devcommand and you will see your public URL in the Nuxt CLI which you can then share with anyone, anywhere in the world.

Simple use example:

yarn dev
or
npm run dev

See Usage.

Development

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

License

MIT License