Building your own PrivMX Desktop Client

About building

By using the provided build scripts, you can build a platform-specific executable package on which you will run the build scripts. At the moment, you can build on Linux, macOS, and Windows operating systems.

The build scripts are mostly written in Bash, so you'll need a Bash-like environment to run them.

Regarding Linux and macOS, all the tools you need are probably already installed on your computer, but for Windows operating systems we suggest installing git-bash and use it throughout the building process.

Building on linux

Install the following libraries:

sudo apt-get install build-essential clang libdbus-1-dev libgtk-3-dev \
                       libnotify-dev libgnome-keyring-dev \
                       libasound2-dev libcap-dev libcups2-dev libxtst-dev \
                       libxss1 libnss3-dev gcc-multilib g++-multilib curl \
                       gperf bison python-dbusmock openjdk-8-jre`

Clone PrivMX Desktop Client public repository to your computer:

git clone https://dev.privmx.com/main/privmx-desktop-client.git

Install NodeJS:

NodeJS version 12 - you can get it from https://nodejs.org/en/download/

Install Typescript:

Typescript version 2.9.2 installed globally:

npm install -g typescript

Install Electron Forge (version 6 - and all the dependencies if needed):

npm i -g @electron-forge/cli

Run make-all

Go to <privmx-client-repo>/build-tools
Run ./make-all

... and that's it!

If the building finished without problems, you should find the package with the ready application in the:
<privmx-client-repo>/build-tools/privmx-electron/out directory.