You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-15Lines changed: 13 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,37 +46,35 @@ This modular design makes it easy to maintain and extend. UI/UX changes can be m
46
46
47
47
There are two ways to get VPNclient App:
48
48
49
-
**1. Install a Pre-built Release (End Users):**
49
+
###Install a Pre-built Release (End Users)
50
50
VPNclient App is in active development and available in beta form:
51
-
-**Android:** Download via Google Play [VPNclient on Google Play](https://play.google.com/store/apps/details?id=vpnclient.click) (or join the testing program). Requires Android 6.0 or higher.
51
+
-**Android:** Download via Google Play [VPNclient on Google Play](https://play.google.com/store/apps/details?id=click.vpnclient.vpnclient) (or join the testing program). Requires Android 6.0 or higher.
52
52
-**iOS:** Download via App Store – [VPNclient on App Store](https://testflight.apple.com/join/KQr4SeS7). Requires iOS 15.6 or higher.
53
53
54
54
After installing, simply launch the app. On first launch, you may be prompted to accept VPN permissions (Android) or install a VPN profile (iOS) – these are required to create the VPN tunnel.
55
55
56
-
**2. Build from Source (Developers):**
56
+
###Build from Source (Developers)
57
57
If you want to try the latest version or modify the app, you can build it yourself:
58
58
59
-
-**Prerequisites:** Install Flutter (Flutter 3 or later recommended) and Dart SDK on your system. Ensure you can run `flutter` commands and have setup Flutter for your target platforms (e.g. Xcode for iOS, Android SDK for Android).
60
-
-**Clone the Repositories:** This app depends on the VPNclient Engine Flutter plugin. Clone the following repository from GitHub:
61
-
```bash
59
+
1.**Prerequisites:** Install Flutter (Flutter 3 or later recommended) and Dart SDK on your system. Ensure you can run `flutter` commands and have setup Flutter for your target platforms (e.g. Xcode for iOS, Android SDK for Android).
60
+
2.**Clone the Repositories:** This app depends on the VPNclient Engine Flutter plugin. Clone the following repository from GitHub:
-**Get Dependencies:** Navigate into the `VPNclient-app` directory and run:
65
-
```bash
64
+
3.**Get Dependencies:** Navigate into the `VPNclient-app` directory and run:
65
+
```sh
66
66
flutter pub get
67
67
```
68
68
This will fetch Flutter packages and link the local plugin.
69
-
-**Platform Setup:**
69
+
4.**Platform Setup:**
70
70
- For **Android**, ensure you have an Android device/emulator and the Android SDK. The app uses the VpnService API; no additional setup is required except granting VPN permissions when prompted.
71
71
- For **iOS**, open the Xcode workspace (`ios/Runner.xcworkspace`) and **enable the “Personal VPN” capability** in the project (this automatically updates entitlements). Also, in `ios/Runner/Info.plist`, ensure the required VPN usage descriptions are present (the engine may use a custom key such as `allow-vpn`). You will need a valid Apple Developer Team provisioning for running VPN entitlements on device.
72
72
- For **macOS/Windows/Linux**, additional setup may be needed (e.g., on Windows, the `wintun` driver should be present; on Linux, you might need root or capabilities to create a TUN interface). Desktop support is experimental and may require manual configuration.
73
-
-**Run the App:** Use Flutter CLI to run on your desired platform:
74
-
```bash
73
+
5.**Run the App:** Use Flutter CLI to run on your desired platform:
74
+
```sh
75
75
flutter run
76
-
```
77
-
This will launch the app on an emulator or connected device. You can also build release APKs or app bundles using `flutter build apk` / `flutter build appbundle` (Android) or an IPA (iOS) with Xcode. For desktop, `flutter run -d macos` or `-d windows` can be used if enabled.
78
-
79
-
*Note:* The repository includes helper shell scripts (`build_android.sh`, `build_ipa.sh`, etc.) which automate some build steps for CI or local packaging.
76
+
```
77
+
This will launch the app on an emulator or connected device. You can also build release APKs or app bundles using `flutter build apk` / `flutter build appbundle` (Android). There is also a lot of other option to build, you can use `flutter build -h` to list all avaliable options.
0 commit comments