|
9 | 9 | </a> |
10 | 10 | <a href="https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A"> |
11 | 11 | <img src="https://img.shields.io/badge/slack-@netbird-red.svg?logo=slack"/> |
12 | | - </a> |
| 12 | + </a> |
| 13 | + <a href="https://github.com/netbirdio/ios-client/actions/workflows/build.yml"> |
| 14 | + <img src="https://github.com/netbirdio/ios-client/actions/workflows/build.yml/badge.svg"/> |
| 15 | + </a> |
| 16 | + <a href="https://github.com/netbirdio/ios-client/actions/workflows/test.yml"> |
| 17 | + <img src="https://github.com/netbirdio/ios-client/actions/workflows/test.yml/badge.svg"/> |
| 18 | + </a> |
13 | 19 | </p> |
14 | 20 | </div> |
15 | 21 |
|
@@ -55,27 +61,37 @@ The code is divided into 4 parts: |
55 | 61 | ## Requirements |
56 | 62 |
|
57 | 63 | - iOS 14.0+ |
58 | | -- Xcode 12.0+ |
| 64 | +- Xcode 16.0+ |
| 65 | +- Go 1.23+ |
59 | 66 | - gomobile |
60 | 67 |
|
61 | 68 | ## Run locally |
62 | 69 |
|
63 | 70 | To build the app, this repository and the main netbird repository are needed. |
64 | 71 |
|
65 | | -``` |
| 72 | +```bash |
66 | 73 | git clone https://github.com/netbirdio/netbird.git |
67 | 74 | git clone https://github.com/netbirdio/ios-client.git |
| 75 | +cd ios-client |
68 | 76 | ``` |
69 | 77 |
|
70 | | -Building the xcframework from the main netbird repo. This needs to be stored in the root directory of the app |
| 78 | +Install gomobile if you haven't already: |
| 79 | +```bash |
| 80 | +go install golang.org/x/mobile/cmd/gomobile@latest |
71 | 81 | ``` |
72 | | -cd netbird |
73 | | -gomobile bind -target=ios -bundleid=io.netbird.framework -o ../ios-client/NetBirdSDK.xcframework ./client/ios/NetBirdSDK |
| 82 | + |
| 83 | +Build the xcframework from the main netbird repo using the build script: |
| 84 | +```bash |
| 85 | +./build-go-lib.sh ../netbird |
74 | 86 | ``` |
75 | 87 |
|
76 | 88 | Open the Xcode project, and we are ready to go. |
77 | 89 |
|
78 | | -> **Note:** The app can not be run in the iOS simulator. To test the app, a physical device needs to be connected to Xcode via cable and set as the run destination. |
| 90 | +> **Note:** The app cannot be run in the iOS simulator. To test the app, a physical device needs to be connected to Xcode via cable and set as the run destination. |
| 91 | +
|
| 92 | +### Firebase Configuration (Optional) |
| 93 | + |
| 94 | +The app supports Firebase for analytics and crash reporting. To enable it, add your `GoogleService-Info.plist` file to the project root. The app will work without Firebase configuration. |
79 | 95 |
|
80 | 96 | ## Other project repositories |
81 | 97 |
|
|
0 commit comments