npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

next-tunnel

v0.1.0

Published

A local tunnel for your next-app

Downloads

7

Readme


NextTunnel

next-tunnel is a CLI tool designed to streamline the process of exposing your local Next.js app to the internet using a secure tunnel. Perfect for local development, testing, or sharing your app with collaborators without deploying to a server.

Features

  • Exposes your local Next.js app to a secure tunnel.

  • Customizable subdomain for easy access.

  • Simple CLI for starting and stopping the tunnel.

  • Seamless integration with existing package.json scripts.

Installation

You can install next-tunnel globally using npm:

npm install -g next-tunnel

Alternatively, install it as a development dependency:

npm install next-tunnel --save-dev

Usage

1. Starting the Tunnel and Next.js App

To start your local Next.js app and expose it via a tunnel, use the dev command. You can specify a custom port and subdomain if needed:

next-tunnel dev [options]

Options:

  • -p, --port <port>: Specify the port number for the Next.js app (default: 3000).

  • -s, --subdomain <subdomain>: Specify a custom subdomain for the tunnel.

  • --secure: Start the tunnel in secure mode 🔒.

  • --lan: Start the tunnel using Local Area Network Connection(i.e your internet router connected devices.) 🔌.

Example:

next-tunnel dev -p 4000 -s my-custom-subdomain

Secure Tunnel:

This will create a secure authenticated tunnel for your local Next.js app. You'll need to provide a password to access the tunnel which is shared along with url.

next-tunnel dev --secure

LAN Tunnel:

This will create a tunnel using your machines LocalIP and only accessible from your local network.

next-tunnel dev --lan   

2. Stopping the Tunnel

To stop the local tunnel, use the stop command:

next-tunnel stop

3. Initializing NextTunnel in Your Project

You can modify your package.json to include next-tunnel as part of your development process. The init command will update your package.json by changing the dev script to run next-tunnel dev.

next-tunnel init

Example package.json after running init:

{
  "scripts": {
    "dev": "next-tunnel dev"
  }
}

Versioning

This package follows semantic versioning . The version is managed using Changesets.

View Version

You can check the current version of next-tunnel using either -v or --version:

next-tunnel -v

Contributing

Contributions are welcome! Please submit a pull request or open an issue if you have suggestions or find bugs.

License

This project is licensed under the MIT License. See the MIT LICENSE file for details.