Skip to content

Latest commit

 

History

History
112 lines (81 loc) · 5.14 KB

README.md

File metadata and controls

112 lines (81 loc) · 5.14 KB
Raw

ElectronSafe

ElectronSafe is a desktop application built with Electron and React that leverages the command-line interface of Veracrypt to provide a user-friendly graphical user interface for creating and mounting encrypted containers.

Media

Video with the complete flow

2024-10-19_16-40-24.mov

Create an encrypted container

create container screenshot

create container screenshot 2

create container screenshot 3

create container screenshot 4

create container notification screenshot

Mount an encrypted container

mount container empty state screenshot

mount container screenshot

Settings

settings screenshot

Light color theme

light color theme

Motivation

The motivation behind this project is to provide a proof of concept for using Electron to interact with CLI tools and give these tools a visually appealing interface without modifying their code. This approach has been successfully implemented in projects like Docker Desktop, where the client is an Electron application. The project currently functions exclusively on Windows. With minor adjustments, it should be compatible with Linux and macOS.

Technologies

  • React
  • Typescript
  • nodepty: Utilized for spawning and controlling a terminal within the Node.js environment. It allows the creation of a pseudo-terminal (pty) that can be programmatically read from and written to, enabling direct interaction with command-line tools.
  • Electron: Empowers the development of cross-platform desktop applications using JavaScript. By leveraging Electron's main process, we interface with nodepty for terminal operations. Inter-process communication (IPC) events are used to transmit data to the renderer process, where React handles the dynamic UI rendering.
  • Tailwind CSS: A highly configurable, utility-first CSS framework that accelerates the styling process by providing low-level utility classes directly in the markup.
  • shadcn: A robust component library that offers a collection of accessible, pre-styled components, enhancing the UI development with consistent design patterns and best practices.
  • Vite

Development

Running node-pty and Electron requires additional dependencies beyond a Node.js installation. The document specifies the versions I am using, but you can experiment with newer ones.

Python

Python is required, you can install Python from the Microsoft Store, the project was built with Python 3.12

Windows SDK

Desktop Development with C++ and MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest) are required, those can be installed using the Visual Studio Installer

.vsconfig

{
  "version": "1.0",
  "components": [
    "Microsoft.VisualStudio.Component.Roslyn.Compiler",
    "Microsoft.Component.MSBuild",
    "Microsoft.VisualStudio.Component.CoreBuildTools",
    "Microsoft.VisualStudio.Workload.MSBuildTools",
    "Microsoft.VisualStudio.Component.Windows10SDK",
    "Microsoft.VisualStudio.Component.VC.CoreBuildTools",
    "Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
    "Microsoft.VisualStudio.Component.VC.Redist.14.Latest",
    "Microsoft.VisualStudio.Component.Windows11SDK.22621",
    "Microsoft.VisualStudio.Component.VC.CMake.Project",
    "Microsoft.VisualStudio.Component.TestTools.BuildTools",
    "Microsoft.VisualStudio.Component.VC.ASAN",
    "Microsoft.VisualStudio.Component.TextTemplating",
    "Microsoft.VisualStudio.Component.VC.CoreIde",
    "Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
    "Microsoft.VisualStudio.Workload.VCTools",
    "Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre"
  ],
  "extensions": []
}

Clone the project

git clone https://github.com/galletafromjell666/electronSafe.git

Move inside the project

cd electronSafe

Install modules

npm install

Rebuild native Node.JS modules against the version that Electron is using

.\node_modules\.bin\electron-rebuild.cmd

Run

npm run dev