@nuxtjs/ngrok

ngrokはあなたのローカルホストを世界に公開し、簡単なテストと共有を可能にします！DNSをいじったり、変更をテストしてもらうためだけにデプロイしたりする必要はありません。

2.7Kダウンロード•71スター•v3.0.1

arashsheyda

@nuxtjs/ngrok

Nuxt ngrok

ngrokを使って、あなたのNuxtアプリケーションを簡単にインターネットに公開できます。

機能

楽な統合：たった1行の設定でngrokをセットアップできます。

セットアップ

@nuxtjs/ngrokをインストールする

npx nuxi@latest module add ngrok

@nuxtjs/ngrokをnuxt.config.tsのmodulesセクションに追加する

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/ngrok',
  ],

  ngrok: {
    // module options
  },
})

これだけです！これでNuxtアプリでngrokを使えます✨

Nuxt 2のサポートについては、@nuxtjs/[email protected]を使用し、v2.nuxtjs.orgの指示に従ってください。

オプション

モジュールオプションを使用して、認証などを追加します。

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/ngrok',
  ],

  ngrok: {
    authtoken_from_env: true, // Use NGROK_AUTHTOKEN environment variable
    // authtoken: 'your_ngrok_authtoken', // Or use this option
    auth: 'username:password',
    domain: 'your_custom_domain',
    production: true,
  },

})

モジュールオプションについて詳しく学ぶ。

使用方法

Nuxtアプリケーションを実行すると、コンソールにngrokのURLが表示されるメッセージが表示されるはずです。

✔ Ngrok connected at https://your_ngrok_url

貢献

ローカル開発

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Release new version
npm run release