Node Multiplatform Wrapper with Tauri

This is a Tauri desktop application created using Node.js and Rust. The app serves as a GUI for interacting with the Calimero node.

Prerequisites

• Node.js (v16 or higher)
• Rust
• pnpm (as the package manager)

Getting Started

1. Clone the repository:

   git clone https://github.com/calimero-network/node-multiplatform-tauri.git

2. Navigate to the project directory:

   cd node-multiplatform-tauri

3. Install the dependencies using pnpm:

   pnpm install

4. Run the development environment:

   pnpm run tauri dev

   • In development mode, the Calimero node binary is stored in the src-tauri/bin folder.
   • Depending on the --target flag during the build or the user's operating system, the app automatically downloads the Calimero node binary directly from the github release page.

   The following --target flags are supported for different architectures:

   • --target aarch64-apple-darwin: For ARM-based macOS (M1 and above)
   • --target x86_64-apple-darwin: For Intel-based macOS
   • --target x86_64-unknown-linux-gnu: For x86_64 Linux systems
   • --target aarch64-unknown-linux-gnu: For ARM-based Linux systems

Build

To create a production build of the application, run:

pnpm run tauri build

• The build process automatically downloads the Calimero node binary directly from the github release page based on the target architecture, if target architecture is not explicitly specified, Tauri will use the host architecture.
• In production mode, the Calimero node binary is stored in the resources folder.
• The build process will fail if the target architecture is not supported by the Calimero node binary release page.
• After building process is complete, the Calimero node binary will be stored in the src-tauri/target folder, exact path will be displayed in the terminal after build process is complete.

Features

• The application has commands defined in src-tauri/src/commands/mod.rs for interacting with the Calimero node:

  • Initialize Node: Create and initialize a new node with specified parameters.
  • Update Node: Modify the configuration of an existing node.
  • Start Node: Start a specified node.
  • Stop Node: Stop a running node.
  • Get Node Log: Retrieve the log file for a specified node.
  • Delete Node: Remove a specified node from the application.
  • Open Dashboard: Open the admin dashboard for a specified node.

• The frontend of the application is built using TypeScript and React, providing a modern and responsive user interface.

• It includes options to run nodes on application startup and to run the application on OS startup.

• The application features an interactive CLI to interact with started nodes.

• There are checks in place to ensure that ports are not already in use and to prevent starting a node with the same name as an already running instance outside of the application.

CI/CD

The project includes a GitHub workflow file that automates the build process for the application on multiple platforms. It builds the application for:

• macOS (both aarch64 and x86 architectures)
• Linux (both aarch64 and x86 architectures)