Metadata-Version: 2.4
Name: NitroExpose
Version: 1.7
Summary: Advanced CLI To Expose Port To Your Domain.
Home-page: https://github.com/yuvrajmodz/NitroExpose
Author: @NacDevs
Author-email: yuvrajmodz@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

## NitroExpose

**Letest Version:** 1.7  
**Developer:** @Nactire  
**Git Repo:** [NitroExpose](https://github.com/yuvrajmodz/NitroExpose)


## 🚀 Overview

**NitroExpose** is an advanced CLI tool that allows you to **instantly expose any local port to your custom domain,**  
**automatic SSL installation** Powered by Let's Encrypt.  

It provides a **one-command deployment system** for developers who want to run their local apps (Flask, FastAPI, Node.js, etc.) directly on a live domain without manually configuring NGINX or DNS records.


## ⚡ Key Features

• Easily Expose Your Local Port to Your Domain.  
• Automatic **NGINX** configuration  
• Automatic **SSL (Let's Encrypt)** installation  
• Required **Root (Sudo)** Environment  
• Intelligent error handling with Fast Speed.  
• Lightweight and Fast Completes setup in under 10 Sec


## 🛠️ System Requirements

- Python **3.8+**  
- **Ubuntu** or **Debian-based** System  
- **Root** or **Sudo** privileges  
- **apt** Package Manager Required


## Installation

```bash
pip install NitroExpose --break-system-packages
```

## Optional installation

```bash
sudo apt update -y
sudo apt install nginx -y
sudo apt install certbot -y
sudo apt install python3-certbot-nginx -y
```

## 🧭 Usage Guide

Step 1 –  Point Your Vps/Server IP in Your Domain Records:
**Type**:  A  
**Name**: *  
**IPv4**:   Your Vps Server IP  
**TTL**:   Auto

Step 2 – **Launch NitroExpose**  
```bash
NitroExpose
```

Step 3 – **Enter Your Domain Or Subdomain**  
```bash
┌─╼ Enter Domain Or Subdomain
└────╼ ❯❯❯ myproject.example.com
```

Step 4 – **Enter the Local Port to Expose**  
```bash
┌─╼ Enter Port To Expose
└────╼ ❯❯❯ 8000
```

✨ **Now it Will Take 8 to 9 Seconds For Verification And Then Boom! Your Local Port Successfully Exposed To Your Public Domain/Subdomain**.
