feat: added ability to export data, added ability to clear results, refactoring, updated README, dependency upgrades

Author: CodeDead

.github/workflows/release.yml

@@ -49,7 +49,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tagName: ${{ github.ref_name }}
-          releaseName: 'Advanced PassGen v__VERSION__'
+          releaseName: 'Advanced PortChecker v__VERSION__'
           releaseBody: 'See the assets to download and install this version.'
           releaseDraft: true
           prerelease: false

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
         run: yarn
 
       - name: Run ESLint
-        run: yarn run eslint . --ext .ts,.tsx,.js,.jsx
+        run: yarn run eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0
 
   test-tauri:
     strategy:

README.md

@@ -1,17 +1,85 @@
 # Advanced PortChecker
 
-![Advanced PassGen](https://i.imgur.com/YazhCxS.png)
+![Advanced PortChecker](https://i.imgur.com/yoWDImn.png)
 
 ![GitHub](https://img.shields.io/badge/language-JavaScript+Rust-green)
 ![GitHub](https://img.shields.io/github/license/CodeDead/Advanced-PortChecker)
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/CodeDead/Advanced-PortChecker)
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Advanced PortChecker is a free and open-source application that can help you check if ports are open or closed on a certain host. You can check multiple ports at once and export the results in plain text, CSV or JSON format!
 
-Currently, two official plugins are available:
+## Building
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Advanced PortChecker uses tauri to build the desktop application. You can find more information about Tauri [here](https://tauri.app/v1/guides/).
+
+For more information about building using `vite`, please read the `Vite` documentation [here](https://vitejs.dev/guide/build.html).
+
+### Development
+
+You can start a development preview by running the `yarn tdev` command:
+```shell
+yarn tdev
+```
+
+### Windows
+
+#### Installer
+
+You can create an executable installer by running the `yarn tbuild` command on a Windows host:
+```shell
+yarn tbuild
+```
+
+### Linux
+
+#### deb
+
+You can create a .deb file, by running the `yarn tbuild` command on a Linux host:
+```shell
+yarn tbuild
+```
+
+#### AppImage
+
+You can create an [AppImage](https://appimage.github.io/) by executing the `yarn tbuild` command on a Linux host:
+```shell
+yarn tbuild
+```
+
+### macOS
+
+#### dmg
+
+You can create a macOS build by running the `yarn tbuild` command on a macOS host:
+```shell
+yarn tbuild
+```
+
+#### Archive
+
+You can create a macOS build by running the `yarn tbuild` command on a macOS host:
+```shell
+yarn tbuild
+```
+
+## Credits
+
+### Tauri
+
+This project uses [Tauri](https://tauri.app/) to create a cross-platform application.
+
+### ReactJS
+
+This project uses [React](https://reactjs.org/) to create the user interface.
+
+### Theme
+
+The theme used in this application is [MUI](https://mui.com/).
+
+### Images
+
+The application icon (and derivatives) are provided by [RemixIcon](https://remixicon.com/).  
+All other images were provided by [MUI](https://mui.com/material-ui/material-icons/).
 
 ## About
 

package.json

@@ -15,8 +15,8 @@
     "@emotion/react": "^11.11.3",
     "@emotion/styled": "^11.11.0",
     "@fontsource/roboto": "^5.0.8",
-    "@mui/icons-material": "^5.15.5",
-    "@mui/material": "^5.15.5",
+    "@mui/icons-material": "^5.15.6",
+    "@mui/material": "^5.15.6",
     "@mui/x-data-grid": "^6.19.1",
     "@tauri-apps/api": "^1.5.3",
     "react": "^18.2.0",

src-tauri/Cargo.lock

@@ -17,9 +17,9 @@ tauri-build = { version = "1.5.1", features = [] }
 [dependencies]
 serde_json = "1.0"
 serde = { version = "1.0", features = ["derive"] }
-tauri = { version = "1.5.4", features = ["os-all"] }
+tauri = { version = "1.5.4", features = [ "dialog-save", "dialog-open", "os-all"] }
 open = "5.0.1"
-chrono = "0.4.31"
+chrono = "0.4.32"
 
 [features]
 # this feature is used for production builds or when `devPath` points to the filesystem and the built-in dev server is disabled.

src-tauri/Cargo.toml

@@ -6,9 +6,9 @@ use std::net::{IpAddr, Shutdown, TcpStream, ToSocketAddrs};
 use std::ops::Deref;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::{Arc, Mutex};
-use std::thread;
 use std::thread::available_parallelism;
 use std::time::Duration;
+use std::{fs, thread};
 
 mod result;
 
@@ -31,12 +31,32 @@ fn main() {
             open_website,
             scan_port_range,
             cancel_scan,
-            get_number_of_threads
+            get_number_of_threads,
+            save_string_to_disk
         ])
         .run(tauri::generate_context!())
         .expect("error while running tauri application");
 }
 
+/// Save a string to disk
+///
+/// # Arguments
+///
+/// * `content` - The content that needs to be saved
+/// * `path` - The path where the content needs to be saved
+///
+/// # Returns
+///
+/// * `Ok(())` - If the content was saved successfully
+/// * `Err(String)` - If the content could not be saved
+#[tauri::command]
+fn save_string_to_disk(content: &str, path: &str) -> Result<(), String> {
+    match fs::write(path, content) {
+        Ok(_) => Ok(()),
+        Err(e) => Err(e.to_string()),
+    }
+}
+
 /// Get the number of threads that can be used for port scanning
 ///
 /// # Returns

src-tauri/src/main.rs

@@ -13,6 +13,10 @@
   "tauri": {
     "allowlist": {
       "all": false,
+      "dialog": {
+        "save": true,
+        "open": true
+      },
       "os": {
         "all": true
       }
@@ -33,7 +37,7 @@
         "icons/icon.ico"
       ],
       "identifier": "com.codedead.advancedportchecker",
-      "longDescription": "",
+      "longDescription": "Advanced PortChecker is a TCP port checker that allows you to check if a port is open or not",
       "macOS": {
         "entitlements": null,
         "exceptionDomain": "",
@@ -42,7 +46,7 @@
         "signingIdentity": null
       },
       "resources": [],
-      "shortDescription": "",
+      "shortDescription": "A TCP Port Checker",
       "targets": "all",
       "windows": {
         "certificateThumbprint": null,