Skip to content

Joansitoh/ufw_manager_gui

Repository files navigation

UFW MANAGER GUI

license last-commit repo-top-language repo-language-count

UFW MANAGER GUI is a Python application that allows you to manage UFW (Uncomplicated Firewall) ports on a remote machine via SSH. The application features a simple and user-friendly graphical interface. I'm new to this so don't kill me either.

electronbuilder JavaScript Prettier HTML5 YAML
Vite React ESLint Electron JSON


🔗 Quick Links


📍 Overview

UFW GUI Manager screenshot 1 UFW GUI Manager screenshot 2 UFW GUI Manager screenshot 3


📦 Features

► Add or delete custom UFW rules ► User-friendly interface ► Secure SSH connection ► List view of open ports


🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

  • Node.js: version 20.0.0 (Only for development)

⚙️ Installation

  1. Clone the repository:
git clone https://github.com/Joansitoh/ufw_manager_gui/
  1. Change to the project directory:
cd
  1. Install the dependencies:
npm install

🤖 Running

Use the following command to run :

npm run dev

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone https://github.com/Joansitoh/ufw_manager_gui/
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.


📄 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

Return