Skip to content

Commit 15a872f

Browse files
committed
docs: update README with contribution guidelines and example project setup
chore: bump RNSwiftUI version to 0.6.0 in Podfile.lock chore: remove unused font reference from Info.plist
1 parent f59a62b commit 15a872f

File tree

4 files changed

+57
-18
lines changed

4 files changed

+57
-18
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,45 @@ Below is a list of components currently supported by `@mgcrea/react-native-swift
154154
| `VStack` | Vertical stack layout | `alignment`, `spacing`, `style`, Children | Alignments: `leading`, `center`, `trailing` |
155155
| `ZStack` | Overlapping stack layout | `alignment`, `style`, Children | Alignments: `topLeading`, `center`, `bottomTrailing`, etc. |
156156

157+
## Contribute
158+
159+
We welcome contributions! If you have ideas for new components, optimizations, or bug fixes, please fork the repository and submit a pull request. We also encourage you to open issues for any bugs or feature requests.
160+
161+
### Prerequisites
162+
163+
- **Xcode**: Ensure you have Xcode installed for iOS development.
164+
- **CocoaPods**: Install CocoaPods if you haven't already. You can do this by running:
165+
```bash
166+
sudo gem install cocoapods
167+
```
168+
- **pnpm**: Install `pnpm` globally if you haven't already:
169+
```bash
170+
npm install --global corepack@latest
171+
corepack enable pnpm
172+
```
173+
174+
### Example Project
175+
176+
To run the example project, follow these steps:
177+
178+
```bash
179+
git clone https://github.com/mgcrea/react-native-swiftui.git
180+
cd react-native-swiftui
181+
182+
pnpm install # install Node.js dependencies
183+
npm run codegen:ios # generate codegen files
184+
185+
bundle install # setup Ruby environment
186+
npm run install:ios # install project native dependencies
187+
188+
cd example
189+
pnpm install # install example Node.js dependencies
190+
191+
npm run ios # run the example project
192+
```
193+
194+
If the build fails, you should try to build from XCode directly using `npm run open:ios` and then run the app from XCode.
195+
157196
### Notes
158197

159198
- **Props**: Most components accept a `style` prop for layout and appearance customization (e.g., `width`, `height`, `backgroundColor`).
@@ -202,3 +241,7 @@ Below is a list of components currently supported by `@mgcrea/react-native-swift
202241
## Contributing
203242

204243
Feel free to fork the repo, experiment with new components, or suggest optimizations! Open issues or PRs on [GitHub](https://github.com/mgcrea/react-native-swiftui).
244+
245+
```
246+
247+
```

example/ios/Podfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1525,7 +1525,7 @@ PODS:
15251525
- React-logger (= 0.78.0)
15261526
- React-perflogger (= 0.78.0)
15271527
- React-utils (= 0.78.0)
1528-
- RNSwiftUI (0.3.0):
1528+
- RNSwiftUI (0.6.0):
15291529
- DoubleConversion
15301530
- glog
15311531
- hermes-engine
@@ -1827,7 +1827,7 @@ SPEC CHECKSUMS:
18271827
ReactAppDependencyProvider: a1fb08dfdc7ebc387b2e54cfc9decd283ed821d8
18281828
ReactCodegen: 008c319179d681a6a00966edfc67fda68f9fbb2e
18291829
ReactCommon: 0c097b53f03d6bf166edbcd0915da32f3015dd90
1830-
RNSwiftUI: 2b5862c12273ae79a3f82313c272762a60399579
1830+
RNSwiftUI: ccd785c5381de96b10bdaf7a3290ff1d2d3fc948
18311831
SocketRocket: d4aabe649be1e368d1318fdf28a022d714d65748
18321832
Yoga: afd04ff05ebe0121a00c468a8a3c8080221cb14c
18331833

example/ios/RNSwiftUIExample.xcodeproj/project.pbxproj

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@
1212
2DCB0BAB44E92647C561E09E /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 13B07FB81A68108700A75B9A /* PrivacyInfo.xcprivacy */; };
1313
761780ED2CA45674006654EE /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 761780EC2CA45674006654EE /* AppDelegate.swift */; };
1414
81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 81AB9BB72411601600AC10FF /* LaunchScreen.storyboard */; };
15-
C0115C47A29A482B8166D4DA /* EurostileUnicaseLTW04-Rg.ttf in Resources */ = {isa = PBXBuildFile; fileRef = 0F6A574EC71C41998DB2ABC2 /* EurostileUnicaseLTW04-Rg.ttf */; };
1615
/* End PBXBuildFile section */
1716

1817
/* Begin PBXFileReference section */
19-
0F6A574EC71C41998DB2ABC2 /* EurostileUnicaseLTW04-Rg.ttf */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = undefined; includeInIndex = 0; lastKnownFileType = unknown; name = "EurostileUnicaseLTW04-Rg.ttf"; path = "../assets/fonts/EurostileUnicaseLTW04-Rg.ttf"; sourceTree = "<group>"; };
2018
13B07F961A680F5B00A75B9A /* RNSwiftUIExample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = RNSwiftUIExample.app; sourceTree = BUILT_PRODUCTS_DIR; };
2119
13B07FB51A68108700A75B9A /* Images.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Images.xcassets; path = RNSwiftUIExample/Images.xcassets; sourceTree = "<group>"; };
2220
13B07FB61A68108700A75B9A /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = RNSwiftUIExample/Info.plist; sourceTree = "<group>"; };
@@ -65,10 +63,8 @@
6563
7DDB2888B55047CB8255E265 /* Resources */ = {
6664
isa = PBXGroup;
6765
children = (
68-
0F6A574EC71C41998DB2ABC2 /* EurostileUnicaseLTW04-Rg.ttf */,
6966
);
7067
name = Resources;
71-
path = "";
7268
sourceTree = "<group>";
7369
};
7470
832341AE1AAA6A7D00B99B32 /* Libraries */ = {
@@ -173,7 +169,6 @@
173169
81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */,
174170
13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */,
175171
2DCB0BAB44E92647C561E09E /* PrivacyInfo.xcprivacy in Resources */,
176-
C0115C47A29A482B8166D4DA /* EurostileUnicaseLTW04-Rg.ttf in Resources */,
177172
);
178173
runOnlyForDeploymentPostprocessing = 0;
179174
};
@@ -204,10 +199,14 @@
204199
inputFileListPaths = (
205200
"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-frameworks-${CONFIGURATION}-input-files.xcfilelist",
206201
);
202+
inputPaths = (
203+
);
207204
name = "[CP] Embed Pods Frameworks";
208205
outputFileListPaths = (
209206
"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-frameworks-${CONFIGURATION}-output-files.xcfilelist",
210207
);
208+
outputPaths = (
209+
);
211210
runOnlyForDeploymentPostprocessing = 0;
212211
shellPath = /bin/sh;
213212
shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-frameworks.sh\"\n";
@@ -243,10 +242,14 @@
243242
inputFileListPaths = (
244243
"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-resources-${CONFIGURATION}-input-files.xcfilelist",
245244
);
245+
inputPaths = (
246+
);
246247
name = "[CP] Copy Pods Resources";
247248
outputFileListPaths = (
248249
"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-resources-${CONFIGURATION}-output-files.xcfilelist",
249250
);
251+
outputPaths = (
252+
);
250253
runOnlyForDeploymentPostprocessing = 0;
251254
shellPath = /bin/sh;
252255
shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-RNSwiftUIExample/Pods-RNSwiftUIExample-resources.sh\"\n";
@@ -273,7 +276,7 @@
273276
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
274277
CLANG_ENABLE_MODULES = YES;
275278
CURRENT_PROJECT_VERSION = 1;
276-
DEVELOPMENT_TEAM = C2CLX8348X;
279+
DEVELOPMENT_TEAM = "";
277280
ENABLE_BITCODE = NO;
278281
INFOPLIST_FILE = RNSwiftUIExample/Info.plist;
279282
IPHONEOS_DEPLOYMENT_TARGET = 15.1;
@@ -302,7 +305,7 @@
302305
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
303306
CLANG_ENABLE_MODULES = YES;
304307
CURRENT_PROJECT_VERSION = 1;
305-
DEVELOPMENT_TEAM = C2CLX8348X;
308+
DEVELOPMENT_TEAM = "";
306309
INFOPLIST_FILE = RNSwiftUIExample/Info.plist;
307310
IPHONEOS_DEPLOYMENT_TARGET = 15.1;
308311
LD_RUNPATH_SEARCH_PATHS = (
@@ -391,10 +394,7 @@
391394
"-DFOLLY_CFG_NO_COROUTINES=1",
392395
"-DFOLLY_HAVE_CLOCK_GETTIME=1",
393396
);
394-
OTHER_LDFLAGS = (
395-
"$(inherited)",
396-
" ",
397-
);
397+
OTHER_LDFLAGS = "$(inherited) ";
398398
REACT_NATIVE_PATH = "${PODS_ROOT}/../../node_modules/react-native";
399399
SDKROOT = iphoneos;
400400
SWIFT_ACTIVE_COMPILATION_CONDITIONS = "$(inherited) DEBUG";
@@ -463,10 +463,7 @@
463463
"-DFOLLY_CFG_NO_COROUTINES=1",
464464
"-DFOLLY_HAVE_CLOCK_GETTIME=1",
465465
);
466-
OTHER_LDFLAGS = (
467-
"$(inherited)",
468-
" ",
469-
);
466+
OTHER_LDFLAGS = "$(inherited) ";
470467
REACT_NATIVE_PATH = "${PODS_ROOT}/../../node_modules/react-native";
471468
SDKROOT = iphoneos;
472469
USE_HERMES = true;

example/ios/RNSwiftUIExample/Info.plist

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@
4949
<false/>
5050
<key>UIAppFonts</key>
5151
<array>
52-
<string>EurostileUnicaseLTW04-Rg.ttf</string>
5352
</array>
5453
</dict>
5554
</plist>

0 commit comments

Comments
 (0)