Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 2.66 KB

README.md

File metadata and controls

117 lines (77 loc) · 2.66 KB
Raw

Mullvad VPN iOS app

This is the iOS version of the Mullvad VPN app. The app can be found on the Apple App Store.

All releases have signed git tags on the format ios/<version>. For changes between each release, see the changelog.

For Xcode project configuration please refer to Configure Xcode project section of build instructions document.

Code formatting

The codebase is formatted using SwiftFormat. Please format all contributions using the latest version of formatter.

swiftformat ios/

Install the latest version of SwiftFormat via Homebrew:

brew install swiftformat

CI uses the latest version available on Homebrew to check formatting, so please keep your local installation up to date, if you see it complain:

brew upgrade swiftformat

Screenshots for AppStore

The process of taking AppStore screenshots is automated using a UI Testing bundle and Snapshot tool, a part of Fastlane tools.

Configuration

The screenshot script uses the real account number to log in, which is provided via Xcode build configuration.

  1. Create the build configuration using a template file:

    cp ios/Configurations/Screenshots.xcconfig.template ios/Configurations/Screenshots.xcconfig

  2. Edit the configuration file and put your account number without quotes:

    vim ios/Configurations/Screenshots.xcconfig

Prerequisitives

  1. Make sure you have rvm installed.

  2. Install Ruby 2.5.1 or later using rvm install <VERSION>.

  3. Install necessary third-party ruby gems:

    cd ios
bundle install

Take screenshots

Run the following command to take screenshots:

cd ios
bundle exec fastlane snapshot

Once done all screenshots should be saved under ios/Screenshots folder.

Localizations

Update localizations from source

Run the following command in terminal:

python3 update_localizations.py

Locking Python dependencies

  1. Freeze dependencies:
pip3 freeze -r requirements.txt

and save the output into requirements.txt.

  1. Hash them with hashin tool:
hashin --python 3.7 --verbose --update-all

Icons and assets

For a general overview of icons and graphics read the graphics readme.

To copy graphical assets from the desktop GUI and generate iOS assets, run:

ios/convert-assets.rb --app-icon
ios/convert-assets.rb --import-desktop-assets
ios/convert-assets.rb --additional-assets