This is a React web application that allows you to connect to a VNC server and view its content within the browser window. You can use this app to remotely access and control a VNC server.
Before running the application, make sure you have Node.js and npm installed on your system. Follow these steps to set up and run the app:
-
Clone the repository:
git clone https://github.com/ismaeleBo/rpi-vnc.git cd rpi-vnc
-
Install dependencies:
npm install
-
Configure the VNC server URL:
- Open the
.env
file and set theREACT_APP_VNC_URL
variable to the URL of your VNC server.
- Open the
-
Start the application:
npm start
The React VNC Web App will run locally, and you can access it in your browser at http://localhost:3000
.
-
Upon launching the app, you will be presented with the main screen.
-
Enter the VNC server password in the password input field.
-
Click the "Connect" button to establish a connection to the VNC server.
-
If the connection is successful, you will see the VNC server content displayed within the browser window.
-
You can use the VNC server as if it were running directly on your computer.
-
To disconnect from the VNC server, click the "Disconnect" button.
-
Connection Modal: If you attempt to connect without entering a password, a connection modal will prompt you to enter the password.
-
Error Handling: If there are connection errors or invalid credentials, an error message will be displayed, allowing you to retry the connection.
-
Security: The app ensures secure VNC connections by using the provided password.
-
Responsive: The VNC content is displayed within the browser window and scales to fit the viewport.
You can customize the appearance and behavior of the app by modifying the React components and styles in the code provided in App.js
and App.css
.
Contributions to this project are welcome! If you'd like to contribute, please follow these steps:
-
Fork the repository on GitHub.
-
Create a branch for your work:
git checkout -b feature/new-feature
-
Make your code changes and improvements.
-
Commit your changes with clear descriptions:
git commit -m "Added new features"
-
Push your changes to your fork:
git push origin feature/new-feature
-
Open a pull request on the main repository.
If you encounter any bugs while using the app or have suggestions for improvements, please open an issue on GitHub with detailed information about the problem.
This React VNC Web App is open-source and distributed under the MIT License. See the [LICENSE] file for more details.
Enjoy using the React VNC Web App to remotely access and control your VNC servers from your browser!