react-host-runner
Version:
Run a React app on a specific IP address and port
49 lines (30 loc) • 1.93 kB
Markdown
# `react-host-runner`
`react-host-runner` is a command-line tool that allows you to run React applications on a specified IP address and port. This package simplifies the process of making your React app accessible over a network by dynamically setting the `HOST` and `PORT` environment variables.
## Features
- Easily start a React app on a specified IP address and port.
- Makes your development server accessible on the local network.
- Simple to integrate into existing React projects.
## Installation
```bash
npm install react-host-runner
```
## Usage
You can use react-host-runner to start your React app on a specific IP address and port.
### Run with Custom IP and Port
```bash
npx react-host-runner 192.168.1.100 3000
```
This command will start your React app on http://192.168.1.100:3000, making it accessible from other devices on the same network.
#### Note: Before running this command, ensure that the specified IP address is available on your network. To do this, you can use the following commands:
macOS: Open a terminal and run ifconfig. Look for the inet entry under the relevant network interface (e.g., en0 for Wi-Fi) to find the available IP addresses.
Windows: Open a command prompt and run ipconfig. Look for the IPv4 Address under the relevant network interface (e.g., Wireless LAN adapter) to find the available IP addresses.
### Run with Default IP and Port
```bash
npx react-host-runner
```
If you run the command without any arguments, react-host-runner will start your React app on the default available IP address. The network IP address will be shown in the terminal:
### Additional Information
- Ensure your React app is set up with react-scripts or a similar tool that supports the HOST and PORT environment variables.
- Make sure the specified IP address is available and correctly configured on your local network.
## License
This project is licensed under the MIT License.