Vite Plugin: localtunnel

localtunnel plugin for Vite to 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.

Prerequisites

This project requires NodeJS (version 14 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
8.5.5
v16.13.2

Table of contents

• Vite Plugin: localtunnel
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
  • Contributing
  • Credits
  • Built With
  • Versioning
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm install vite-plugin-localtunnel

Or if you prefer using Yarn:

$ yarn add vite-plugin-localtunnel

Usage

// vite.config.js
import { defineConfig } from 'vite'
import localtunnel from 'vite-plugin-localtunnel'


// https://vitejs.dev/config/
export default defineConfig(({mode}) => {
  return {
    plugins: [
      // ...
      !(mode === 'development') || localtunnel({
        subdomain: 'your-subdomain', // set or set null for a random subdomain 
      }),
      // ...
    ],
    // ...
  }
})

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request 😎

Credits

• localtunnel/localtunnel

Built With

• JavaScript
• Love

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gustavo RPS - Initial work - @gustavorps

See also the list of contributors who participated in this project.

License

ISC