nport 2.0.4 → 2.0.6

package/CHANGELOG.md

@@ -0,0 +1,175 @@
+# Changelog
+
+All notable changes to NPort will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.6] - 2026-01-13
+
+### Added
+- 🔧 **Backend URL Configuration**: Full control over backend server
+  - `--backend` / `-b` flag for temporary backend override
+  - `--set-backend` command to save backend URL permanently
+  - `NPORT_BACKEND_URL` environment variable support
+  - Saved backend configuration persists across sessions
+  - Priority system: CLI flag > Saved config > Env var > Default
+- 🗂️ **Unified Configuration System**: All settings in one place
+  - New centralized `config-manager.js` module
+  - All preferences stored in `~/.nport/config.json`
+  - Automatic migration from old format (v2.0.5)
+  - Easy to read and manually edit JSON format
+- 🌐 **New Default Backend**: Updated to `api.nport.link`
+  - Professional domain structure
+  - Better branding alignment
+  - Shorter and easier to remember
+
+### Changed
+- 📝 **Language Configuration**: Now uses unified config system
+  - Language setting moved from `~/.nport/lang` to `~/.nport/config.json`
+  - Automatic migration from old file format
+  - Consistent configuration approach across all settings
+- 📚 **Documentation Updates**: Complete overhaul
+  - Updated `README.md` with backend configuration options
+  - New `CLIENT_SETUP.md` focused on npm installation and backend setup
+  - Comprehensive backend URL documentation
+  - Clear priority order explanation
+
+### Improved
+- 🎯 **Consistency**: Unified approach to all configuration
+  - Backend URL and language now use same storage system
+  - Single config file for all preferences
+  - Cleaner architecture and code organization
+- 💾 **Configuration File Structure**:
+  ```json
+  {
+    "backendUrl": "https://api.nport.link",
+    "language": "en"
+  }
+  ```
+
+### Migration
+- Automatic migration from v2.0.5 configuration files
+- Old `~/.nport/lang` file automatically migrated to `config.json`
+- No manual steps required
+- Old files removed after successful migration
+
+## [2.0.5] - 2026-01-13
+
+### Added
+- 🌍 **Multilingual Support**: Full internationalization with English and Vietnamese
+  - Interactive language selection on first run
+  - `--language` / `-l` flag to change language anytime
+  - Language preference saved to `~/.nport/lang`
+- 🎨 **Enhanced UI**: Complete redesign with better visual hierarchy
+  - New header design with Vietnamese pride
+  - Improved connection status messages
+  - Better formatted output with consistent spacing
+  - Language change hint in goodbye message
+- 📂 **Modular Architecture**: Refactored codebase into organized modules
+  - Split code into `/src` directory with clear separation of concerns
+  - Better maintainability and testability
+  - Modules: config, state, args, binary, api, version, ui, tunnel, lang, analytics
+- ✅ **Version Command**: Added `-v` / `--version` flag
+  - Shows current version
+  - Checks for updates automatically
+  - Displays update instructions if available
+- 📝 **Configuration Directory**: Organized config files under `~/.nport/`
+  - Language preference: `~/.nport/lang`
+  - Analytics ID: `~/.nport/analytics-id`
+
+### Changed
+- 🎯 **Improved Console Output**: Better formatting and spacing throughout
+  - Connection messages now properly indented
+  - Time remaining display updated
+  - Footer redesigned with clearer calls-to-action
+- 🔧 **Better Argument Parsing**: Enhanced CLI argument handling
+  - Support for multiple language flag formats
+  - Interactive prompt when using `--language` without value
+- 📚 **Updated Documentation**: Complete README overhaul
+  - Added multilingual feature documentation
+  - New CLI options table
+  - Project structure documentation
+  - Cleaner examples and better organization
+
+### Fixed
+- 🐛 **Terminal Compatibility**: Removed problematic emoji flags
+  - Vietnamese flag emoji replaced with text
+  - Better compatibility across different terminals
+
+## [2.0.4] - Previous Release
+
+### Features
+- Basic tunnel functionality
+- Custom subdomain support
+- Cloudflare integration
+- Auto-cleanup on exit
+- 4-hour tunnel timeout
+
+---
+
+## Version Upgrade Guide
+
+### From 2.0.5 to 2.0.6
+
+```bash
+npm install -g nport@latest
+```
+
+**New Features to Try:**
+
+1. **Set Your Backend Permanently**
+   ```bash
+   nport --set-backend https://api.nport.link
+   ```
+
+2. **Use Custom Backend Temporarily**
+   ```bash
+   nport 3000 -b https://your-backend.com
+   ```
+
+3. **Check Current Configuration**
+   ```bash
+   cat ~/.nport/config.json
+   ```
+
+4. **Use Environment Variable**
+   ```bash
+   export NPORT_BACKEND_URL=https://your-backend.com
+   nport 3000
+   ```
+
+**Breaking Changes:** None - fully backward compatible!
+
+**Migration:** Your language preference from v2.0.5 will be automatically migrated to the new unified config format.
+
+### From 2.0.4 to 2.0.5
+
+```bash
+npm install -g nport@latest
+```
+
+**New Features to Try:**
+
+1. **Change Language**
+   ```bash
+   nport --language
+   ```
+
+2. **Check Version**
+   ```bash
+   nport -v
+   ```
+
+3. **Direct Language Selection**
+   ```bash
+   nport 3000 -l vi  # Vietnamese
+   nport 3000 -l en  # English
+   ```
+
+**Breaking Changes:** None - fully backward compatible!
+
+---
+
+Made with ❤️ in Vietnam by [Nick Pham](https://github.com/tuanngocptn)
+

package/README.md

@@ -29,6 +29,7 @@ Perfect for:
 - 📡 **WebSocket Support**: Full WebSocket and Server-Sent Events support
 - 🎯 **No Configuration**: Works out of the box
 - 💻 **Cross-Platform**: Windows, macOS, and Linux support
+- 🗣️ **Multilingual**: English and Vietnamese UI support
 - 🆓 **100% Free**: No accounts, no limits, no paywalls
 - 🔓 **Open Source**: MIT licensed
 
@@ -61,18 +62,29 @@ nport 3000
 
 Output:
 ```
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-  NPort - Free & Open Source ngrok Alternative
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-  🌐 Website: https://nport.link
-  📦 NPM:     https://www.npmjs.com/package/nport
-  💻 GitHub:  https://github.com/tuanngocptn/nport
-  ☕ Support: https://buymeacoffee.com/tuanngocptn
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-
-🚀 Starting Tunnel for port 3000...
-✔ Tunnel created!
-🌍 Public URL: https://user-1234.nport.link
+ ╭────────────────────────────────────────────────────────╮
+ │  N P O R T  ⚡️  Free & Open Source from Vietnam        │
+ ╰────────────────────────────────────────────────────────╯
+
+⠋ Creating tunnel for port 3000...
+   🚀 WE LIVE BABY!
+   
+   👉  https://user-1234.nport.link  👈
+   
+   ───────────────────────────────────────────────────────
+   
+   ⏱️  Time:     4h remaining
+   
+   ✔ [1/2] Connection established...
+   ✔ [2/2] Compression enabled...
+   
+   ───────────────────────────────────────────────────────
+   
+   🔥 KEEP THE VIBE ALIVE?
+      (Made with ❤️ in Vietnam)
+
+   ⭐️  Drop a Star:   https://github.com/tuanngocptn/nport
+   ☕️  Buy Coffee:    https://buymeacoffee.com/tuanngocptn
 ```
 
 ### Custom Subdomain
@@ -146,7 +158,89 @@ nport <port> [options]
 |--------|-------|-------------|---------|
 | `<port>` | - | Local port to tunnel (default: 8080) | `nport 3000` |
 | `--subdomain` | `-s` | Custom subdomain | `nport 3000 -s myapp` |
-| `-s=value` | - | Alternative format | `nport 3000 -s=myapp` |
+| `--backend` | `-b` | Custom backend URL (temporary) | `nport 3000 -b https://your-backend.com` |
+| `--set-backend` | - | Save backend URL permanently | `nport --set-backend https://your-backend.com` |
+| `--language` | `-l` | Set language (en/vi) or prompt | `nport 3000 -l vi` |
+| `--version` | `-v` | Show version information | `nport -v` |
+
+### Language Options
+
+NPort supports multiple languages with automatic detection on first run.
+
+```bash
+# Set language directly
+nport 3000 --language en    # English
+nport 3000 -l vi            # Vietnamese
+
+# Open language selection menu
+nport --language            # Interactive prompt
+nport -l                    # Interactive prompt
+```
+
+On first run or when using `--language` without a value, you'll see an interactive language picker. Your choice is automatically saved for future sessions.
+
+### Backend URL Options
+
+NPort uses a default backend at `https://api.nport.link`, but you can use your own backend server.
+
+#### Temporary Backend (One-time Use)
+
+Use a custom backend for just the current session:
+
+```bash
+# Use custom backend via CLI flag
+nport 3000 --backend https://your-backend.com
+nport 3000 -b https://your-backend.com
+
+# Use custom backend via environment variable
+export NPORT_BACKEND_URL=https://your-backend.com
+nport 3000
+
+# Combine with other options
+nport 3000 -s myapp -b https://your-backend.com
+```
+
+#### Persistent Backend (Saved Configuration)
+
+Save a backend URL to use automatically in all future sessions:
+
+```bash
+# Save backend URL permanently
+nport --set-backend https://your-backend.com
+
+# Now all future commands will use this backend
+nport 3000              # Uses saved backend
+nport 3000 -s myapp     # Uses saved backend
+
+# Clear saved backend (return to default)
+nport --set-backend
+
+# Override saved backend temporarily
+nport 3000 -b https://different-backend.com
+```
+
+**Configuration Priority:**
+1. CLI flag (`--backend` or `-b`) - Highest priority
+2. Saved config (`--set-backend`)
+3. Environment variable (`NPORT_BACKEND_URL`)
+4. Default (`https://api.nport.link`) - Lowest priority
+
+**Configuration Storage:**
+Your backend preference is saved in `~/.nport/config.json`
+
+This is useful if you want to:
+- **Self-host**: Run your own NPort backend (see [server/](server/) directory)
+- **Development**: Test against a local backend
+- **Custom domains**: Use your own domain for tunnel URLs
+- **Enterprise**: Use a company-hosted backend server
+
+### Version Information
+
+```bash
+# Check current version and updates
+nport -v
+nport --version
+```
 
 ## 🔧 How It Works
 
@@ -162,12 +256,36 @@ Internet → Cloudflare Edge → Cloudflare Tunnel → Your localhost:3000
          (https://myapp.nport.link)
 ```
 
+## 🏗️ Project Structure
+
+NPort uses a modular architecture for better maintainability:
+
+```
+nport/
+├── index.js              # Main entry point
+├── src/
+│   ├── analytics.js      # Analytics tracking
+│   ├── api.js            # Backend API client
+│   ├── args.js           # CLI argument parser
+│   ├── binary.js         # Cloudflared binary manager
+│   ├── bin-manager.js    # Binary download/installation
+│   ├── config.js         # Configuration constants
+│   ├── lang.js           # Multilingual support
+│   ├── state.js          # Application state
+│   ├── tunnel.js         # Tunnel orchestration
+│   ├── ui.js             # User interface display
+│   └── version.js        # Version management
+└── bin/
+    └── cloudflared       # Cloudflare tunnel binary
+```
+
 ## 🛡️ Security
 
 - **HTTPS by default**: All tunnels use SSL/TLS encryption
 - **Cloudflare protection**: DDoS protection and security features
 - **Automatic cleanup**: Tunnels are removed when you stop the process
 - **No data logging**: We don't store or log your traffic
+- **Privacy**: Anonymous analytics (can be disabled with `NPORT_ANALYTICS=false`)
 
 ## 🆚 Comparison with ngrok
 
@@ -177,9 +295,10 @@ Internet → Cloudflare Edge → Cloudflare Tunnel → Your localhost:3000
 | Custom subdomains | ✅ Always | ❌ Paid only |
 | HTTPS | ✅ Always | ✅ |
 | Account required | ❌ No | ✅ Yes |
-| Time limits | ❌ None | ⚠️ Free tier limited |
+| Time limits | ❌ None (4h auto-cleanup) | ⚠️ Free tier limited |
 | Open source | ✅ MIT | ❌ Proprietary |
 | Global network | ✅ Cloudflare | ✅ ngrok Edge |
+| Multilingual | ✅ EN/VI | ❌ English only |
 
 ## 🧹 Cleanup
 
@@ -193,6 +312,8 @@ The cleanup process:
 2. ✅ Removes Cloudflare Tunnel
 3. ✅ Stops cloudflared process
 
+Tunnels also auto-cleanup after **4 hours** to prevent resource waste.
+
 ## 🐛 Troubleshooting
 
 ### Binary not found
@@ -222,6 +343,24 @@ nport 3000 -s myapp-v2
 
 The `ERR Cannot determine default origin certificate path` warning is harmless and can be ignored. It appears because cloudflared checks for certificate-based authentication (we use token-based instead).
 
+### Change language
+
+To change your language preference:
+```bash
+nport --language
+# or
+nport -l
+```
+
+Then select your preferred language from the menu.
+
+## 🌍 Supported Languages
+
+- 🇺🇸 **English** (`en`) - Default
+- 🇻🇳 **Vietnamese** (`vi`) - Tiếng Việt
+
+Want to add your language? Contributions are welcome! Check out `src/lang.js` to see how easy it is to add translations.
+
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
@@ -232,6 +371,24 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+### Adding a New Language
+
+To add a new language:
+
+1. Open `src/lang.js`
+2. Add your language code to `availableLanguages` array
+3. Add translations to the `TRANSLATIONS` object
+4. Submit a PR!
+
+Example:
+```javascript
+const TRANSLATIONS = {
+  en: { /* English translations */ },
+  vi: { /* Vietnamese translations */ },
+  es: { /* Your Spanish translations */ },
+};
+```
+
 ## 💖 Support
 
 If you find NPort useful, please consider supporting the project:
@@ -240,6 +397,7 @@ If you find NPort useful, please consider supporting the project:
 - ☕ [Buy me a coffee](https://buymeacoffee.com/tuanngocptn)
 - 💬 Share with your friends and colleagues
 - 🐛 [Report bugs](https://github.com/tuanngocptn/nport/issues)
+- 🌍 [Add translations](https://github.com/tuanngocptn/nport/blob/main/src/lang.js)
 
 ## 📄 License
 
@@ -247,7 +405,7 @@ If you find NPort useful, please consider supporting the project:
 
 ## 🙏 Credits
 
-- Created by [Nick Pham](https://github.com/tuanngocptn) 🇻🇳
+- Created by [Nick Pham](https://github.com/tuanngocptn) from Vietnam
 - Powered by [Cloudflare Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/)
 - Inspired by [ngrok](https://ngrok.com) and [localtunnel](https://github.com/localtunnel/localtunnel)
 
@@ -260,4 +418,4 @@ If you find NPort useful, please consider supporting the project:
 
 ---
 
-Made with ❤️ by [Nick Pham](https://github.com/tuanngocptn)
+Made with ❤️ in Vietnam by [Nick Pham](https://github.com/tuanngocptn)