Windscribe for iOS and tvOS are native apps written in Swift. Features include support for multiple VPN protocols, per-network configuration, and On-Demand mode.
Windscribe iOS and tvOS app can be downloaded from the App Store:
Link
Check our Acknowledgements file for a list of third-party libraries used in this project.
- iOS 15.0+
- tvOS 17.0+
- Xcode 15.0+
- Swift 5.9+
- Go 1.16+
- swiftlint
- go
- CocoaLumberjack/Swift
- Realm
- RealmSwift
- IQKeyboardManagerSwift
- ExpyTableView
- SwipeCellKit
- AES256Encrypter
- OpenVPNAdapter
- RxSwift
- RxGesture
- RxDataSources
- Swinject
- RxRealm
- SnapKit
-
Clone this repository
git clone <repo-url> cd Windscribe
-
Open the project in Xcode
open Windscribe.xcodeproj
-
In Xcode, go to File > Packages > Add Package Dependencies and ensure all required Swift packages are properly resolved.
-
Choose the correct scheme from the available options:
Windscribe-Default(release configuration with debug flags enabled)Windscribe-ReleaseWindscribe-StagingWindscribe-tvOS(for building and running on Apple TV devices)
-
Navigate to
Windscribe/Environments/Config.xcconfigand set your:Team IDApp Bundle ID
-
Set up code signing under
Targets > Signing & Capabilitiesusing your Apple Developer account. -
Clean the project:
Product > Clean Build Folder(Cmd + Shift + K)
-
Resolve all packages:
File > Packages > Resolve Package Versions
-
Connect a real device (iPhone/iPad for iOS or Apple TV for tvOS) and run the app.
Simulators are supported, but VPN connections require physical hardware.
- If build fails or dependencies don't resolve:
- Clear Derived Data:
Xcode > Settings > Locations > Derived Data - Reopen the project and resolve packages again
- Clear Derived Data:
- Fork this repository
- Create an issue first and describe your proposed changes or bug fix
- Submit a pull request referencing the issue number
- Ensure the code builds successfully and passes linting:
swiftlint lint
This project uses Semantic Versioning:
Major.Minor.Patch (BuildNumber)
Example: 3.8.5 (22) on TestFlight