Rogue for iOS

Rogue for iOS is a native app built using Swift language. It uses Wireguard protocol.

• About this Repo
• Installation
• Testing
• Deployment
• Versioning
• Security Policy

About this Repo

This is the official Git repo of the Rogue for iOS project. This is a fork of IVPN IVPN for iOS project.

Installation

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

Requirements

• iOS 12.0+
• Xcode 11.0+
• Swift 5.0+
• Git (preinstalled with Xcode Command Line Tools)
• Ruby (preinstalled with macOS)
• CocoaPods 1.10.0+
• fastlane 2.137.0+
• Go 1.15+

Dev dependencies

Project dev dependencies:

• CocoaPods
• fastlane
• SwiftLint
• Go

Install CocoaPods:

$ sudo gem install cocoapods

Install fastlane, SwiftLint and Go:

$ brew install fastlane swiftlint go

Dependencies

Dependencies are installed with CocoaPods.
WireGuard static library is compiled at Xcode build phase from implementation of WireGuard in Go.

Project dependencies:

• wireguard-go
• TunnelKit
• Bamboo
• KeychainAccess
• SwiftyStoreKit
• JGProgressHUD
• SDCAlertView
• ActiveLabel
• ReachabilitySwift
• Sentry

To pull and build dependencies run:

$ pod install  
$ open Rogue-iOS.xcworkspace  

Xcode build configurations

There are different build configurations: Staging and Release.

Rename and populate .xcconfig files:

$ cp RogueClient/Config/staging.template.xcconfig RogueClient/Config/staging.xcconfig  
$ cp RogueClient/Config/release.template.xcconfig RogueClient/Config/release.xcconfig  
$ cp wireguard-tunnel-provider/Config/wg-staging.template.xcconfig wireguard-tunnel-provider/Config/wg-staging.xcconfig   
$ cp wireguard-tunnel-provider/Config/wg-release.template.xcconfig wireguard-tunnel-provider/Config/wg-release.xcconfig   

OpenVPN configuration

Rename and populate OpenVPNConf.swift file:

$ cp RogueClient/Config/OpenVPNConf.template.swift RogueClient/Config/OpenVPNConf.swift

Fastlane configuration

Rename and populate Appfile files:

$ cp fastlane/Appfile.template fastlane/Appfile

Testing

Run code linter using fastlane:

$ fastlane lint

Run tests using fastlane:

$ fastlane test

Alternatively, run tests using xcodebuild:

$ xcodebuild test -workspace Rogue-iOS.xcworkspace -scheme RogueClient -destination 'platform=iOS Simulator,name=iPhone 11 Pro'

Deployment

To build and deploy beta build to TestFlight:

$ fastlane beta

To build and deploy staging build to TestFlight:

$ fastlane staging

To build and deploy App Store release build to TestFlight:

$ fastlane release

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 Rogue for iOS 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.

Acknowledgements

See the Acknowledgements file for the list of third party libraries used in this project.