FFFF GitHub - Plogoman/vacayyay_fullstack · GitHub
[go: up one dir, main page]

Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Running VacayYay Locally & Sharing Online with ngrok

Prerequisites

Make sure you have Node.js installed. Check by running:

node -v
npm -v

If not installed, download it from nodejs.org (LTS version recommended).


1. Install npm dependencies

Navigate to the project folder and install everything:

cd vacayyay_fullstack
npm install

This reads package.json and installs all dependencies into node_modules/.


2. Start the server

Normal start:

npm start

Auto-restart on file changes (development):

npm run dev

Requires nodemon which is already in the dev dependencies.

The app will be live at http://localhost:3000


3. Install ngrok

ngrok creates a public URL that tunnels to your localhost so anyone on the internet can access your app.

Option A — Download directly

  1. Go to ngrok.com and create a free account
  2. Download the binary for your OS from the dashboard
  3. Move it somewhere on your PATH (e.g. /usr/local/bin/ngrok on Linux/Mac)

Option B — Install via package manager

Mac (Homebrew):

brew install ngrok/ngrok/ngrok

Linux (snap):

sudo snap install ngrok

Windows (Chocolatey):

choco install ngrok

Verify install:

ngrok version

4. Authenticate ngrok (one-time setup)

After creating your free account at ngrok.com, copy your auth token from the dashboard and run:

ngrok config add-authtoken YOUR_TOKEN_HERE

You only need to do this once — it saves to ~/.config/ngrok/ngrok.yml.


5. Share your app online

Make sure your server is already running (npm start), then in a separate terminal:

ngrok http 3000

ngrok will display something like:

Forwarding   https://abc123.ngrok-free.app -> http://localhost:3000

Share that https://...ngrok-free.app URL with anyone — they can access your running app from anywhere.

Note: On the free plan, visitors will see an ngrok warning page on first visit. They just click "Visit Site" to proceed. The URL also changes every time you restart ngrok.


6. Full startup (both at once)

Open two terminal windows:

Terminal 1 — start the app:

cd vacayyay_fullstack
npm start

Terminal 2 — start the tunnel:

ngrok http 3000

Stopping everything

  • Stop the Node server: Ctrl + C in Terminal 1
  • Stop ngrok: Ctrl + C in Terminal 2

Or kill by port if something is stuck:

# Linux / Mac
fuser -k 3000/tcp

# Windows
netstat -ano | findstr :3000
taskkill /PID <PID> /F

Quick reference

Command What it does
npm install Install dependencies
npm start Start the server
npm run dev Start with auto-reload
ngrok http 3000 Create public tunnel to port 3000
ngrok config add-authtoken TOKEN Save your ngrok auth token

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0