acardozzo / desktop-app-ui2

IVPN Desktop app

This is a legacy project. Development has been moved to a new repository: https://github.com/ivpn/desktop-app

IVPN Client UI

IVPN Client UI is a multi-platform UI for IVPN Client Desktop (ivpn-desktop-daemon) built using Electron (supported platforms: macOS, Linux, Windows).

IVPN Client app is distributed on the official site www.ivpn.net.

• About this Repo
• Installation
• Versioning
• Contributing
• Security Policy
• License
• Authors

About this Repo

This is the official Git repo of the IVPN Client UI2.

Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Requirements

Windows

• npm
• nsis2
• Build Tools for Visual Studio 2019 ('Windows SDK 10.0', 'MSVC v142 C++ x64 build tools', 'C++ ATL for latest v142 build tools')
• gcc compiler e.g. TDM GCC
• Go 1.13+
• Git

macOS

• npm
• Xcode Command Line Tools
• Go 1.13+
• Git

Linux

• npm
• packages: FPM, curl, rpm, libiw-dev
• Go 1.13+
• Git

Compilation

Windows

Instructions to build Windows installer of IVPN Client software (daemon+CLI+UI):
Use Developer Command Prompt for Visual Studio (required for building native sub-projects).

git clone https://github.com/ivpn/desktop-app-daemon.git
git clone https://github.com/ivpn/desktop-app-cli.git
git clone https://github.com/ivpn/desktop-app-ui2.git
cd desktop-app-ui2/References/Windows
build.bat

Compiled binaries can be found at: desktop-app-ui2\References\Windows\bin

macOS

Instructions to build macOS DMG package of IVPN Client software (daemon+CLI+UI):

git clone https://github.com/ivpn/desktop-app-daemon.git
git clone https://github.com/ivpn/desktop-app-cli.git
git clone https://github.com/ivpn/desktop-app-ui2.git
cd ivpn/desktop-app-ui2/References/macOS
./build.sh -v <VERSION_X.X.X> -c <APPLE_DevID_CERTIFICATE>

Compiled binary can be found at: desktop-app-ui2/References/macOS/_compiled

Linux

Instructions to build Linux DEB and RPM packages of IVPN software 'UI' package:

git clone https://github.com/ivpn/desktop-app-ui2.git
cd desktop-app-ui2/References/Linux
./build.sh -v <VERSION_X.X.X>

Compiled packages can be found at desktop-app-ui2/References/Linux/_out_bin

Note! It is required to have installed IVPN Daemon before running IVPN UI.
Info: You may be interested also in IVPN Client CLI project to build a 'base' Linux redistributable package (daemon + CLI) of IVPN software.

Versioning

Project is using Semantic Versioning (SemVer) for creating release versions.

SemVer is a 3-component system in the format of x.y.z where:

x stands for a major version
y stands for a minor version
z stands for a patch

So we have: Major.Minor.Patch

Contributing

If you are interested in contributing to IVPN Client project, please read our Contributing Guidelines.

Security Policy

If you want to report a security problem, please read our Security Policy.

License

This project is licensed under the GPLv3 - see the License file for details.

Authors

See the Authors file for the list of contributors who participated in this project.