• Stars
    star
    307
  • Rank 132,778 (Top 3 %)
  • Language
    Swift
  • License
    GNU General Publi...
  • Created almost 3 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Official ProtonVPN iOS and macOS app

ProtonVPN for iOS and macOS

Copyright (c) 2021 Proton Technologies AG

Dependencies

This app uses CocoaPods for most dependencies. Everything is inside this repository, so no need to run pod install.

Third-party dependencies

ACKNOWLEDGEMENTS.md

Setup

  • Enable Git LFS on your machine
  • Clone this repository
  • Make sure you have go installed (brew install go)
  • Configure code signing for all targets with a paid Apple developer account (required due to VPN entitlements) and change the bundle identifiers to something unique
  • Clean build folder in Xcode (Cmd+Shift+K)
  • Build app twice

Code linting

During development swiftlint is run on non-strict mode so it's easier to develop without worrying about code formatting. On CI, linting is strict and will fail on any warning. Before commiting code to this repository run the following script to add a pre-commit hook that will check all new/modified files in strict mode and stop you from committing code that won't make it through CI.

./scripts/pre_commit_lint.sh setup

Localization

The app uses SwiftGen to generate the Localizable.strings file for accessing all the app strings stored in the standard Localizable.strings files. Just add a new string, build the project and Localizable.strings gets regenerated with the new string. The configuration can be found in libraries/vpncore/swiftgen.yml.

Obscure XCode errors

If you get obscure XCode errors like an error from swiftlint without a place where it comes from, switch to vpncore-ios or vpncore-macos scheme and build it. Most probably lint error is in the Core project.

License

The code and data files in this distribution are licensed under the terms of the GPLv3 as published by the Free Software Foundation. See https://www.gnu.org/licenses/ for a copy of this license.

Copyright (c) 2021 Proton Technologies AG

More Repositories

1

android-app

Official ProtonVPN Android app
C
2,006
star
2

win-app

Official ProtonVPN Windows app
C#
1,157
star
3

protonvpn-cli

Legacy protonvpn-cli: ProtonVPN Command-Line Tool for Linux and macOS. This has been superseded by https://github.com/ProtonVPN/protonvpn-cli-ng
Shell
606
star
4

linux-app

Official ProtonVPN Linux app
Python
401
star
5

ios-app

Superseded by https://github.com/ProtonVPN/ios-mac-app
Swift
341
star
6

linux-cli

Official ProtonVPN Linux app (CLI)
Python
326
star
7

mac-app

Superseded by https://github.com/ProtonVPN/ios-mac-app
Swift
234
star
8

proton-vpn-gtk-app

Official ProtonVPN Linux app
Python
143
star
9

proton-vpn-settings

ProtonVPN React web application
JavaScript
59
star
10

vpncore

Core application code shared between the iOS and macOS apps
Swift
57
star
11

protonvpn-nm-lib

Python
40
star
12

wireguard-go

Go
23
star
13

scripts

ProtonVPN's related scripts and static contents.
Shell
23
star
14

go-vpn-lib

Go
21
star
15

win-openvpn

Scripts for building OpenVPN used in ProtonVPN Windows app
Dockerfile
15
star
16

win-tap-adapter

Scripts for building OpenVPN TAP adapter used in ProtonVPN Windows app
PowerShell
13
star
17

python-proton-vpn-api-core

Python
8
star
18

wireguard-android

Kotlin
8
star
19

python-proton-core

Python
5
star
20

python-proton-vpn-session

Python
4
star
21

python-proton-keyring-linux

Python
3
star
22

python-proton-vpn-killswitch-network-manager

Python
3
star
23

python-proton-vpn-connection

Python
3
star
24

python-proton-vpn-logger

Python
2
star
25

python-proton-vpn-network-manager-openvpn

Python
2
star
26

python-proton-vpn-killswitch

Python
2
star
27

python-proton-vpn-network-manager

Python
2
star
28

.github

2
star
29

python-proton-keyring-linux-secretservice

Python
1
star