Skip to content

πŸ” A free, light and easy to use desktop tool to generate PGP key pairs, encrypt and decrypt messages.

License

Notifications You must be signed in to change notification settings

aliceandbob-io/aliceandbob-desktop

Repository files navigation

aliceandbob.io - Desktop app πŸ–₯οΈπŸ”

A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.

Download it ⬇️

Installation

⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.

Features ✨

  • πŸ—οΈ Generate PGP key pairs
  • πŸ”’ Encrypt messages with the public PGP key of the receiver
  • πŸ”“ Decrypt messages with your private PGP key

Tech πŸ”§

  • Electron.js: Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
  • Electron-forge: Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
  • HTML/CSS/Javascript
  • Stimulus JS (v2.0.0): A modest JavaScript framework
  • Webpack: The whole app is bundle with webpack through the electron-forge webpack plugin

Library πŸ“š

OpenPGP.js (v5.3.0), a JavaScript implementation of the OpenPGP protocol. Find out more on openpgpjs.org.

Contributing 🍰

Please contribute using GitHub Flow. Refer first to the open issues then create a branch, add commits, and open a pull request!

You can also read the CODE OF CONDUCT.

When forking and cloning the repo, don't forget to do the following:

  1. Make sure to have node, npm and yarn installed on your machine
  2. run yarn install from the cloned repo.
  3. Then, yarn start to launch aliceandbob.io Desktop App in dev mode.

⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.

Find more info regarding the process and the configuration on the electronforge.io page.

Building the desktop app locally πŸ—οΈ

If you want to package and build the app on your machine, run yarn make --platform=<target build platform> --arch=<target arch>. As for the platform, you can choose either:

  • win32,
  • linux,
  • darwin, or
  • mas.

As for the arch, you can choose either:

  • x64,
  • ia32,
  • armv7l,
  • arm64, or
  • mips64el.

See all available options on the electronPackager page.

Note that some specific builds cannot be done from some platforms. Learn more here.

Want to support the app? ❀️

Buy Me A Coffee

License πŸ“„

Licensed under the MIT License.