openmobilehub / react-native-omh-auth

https://openmobilehub.github.io/react-native-omh-auth/
Apache License 2.0
0 stars 0 forks source link

Missing Instructions for `pod install` in Contributing Guide #64

Closed dzuluaga closed 1 month ago

dzuluaga commented 1 month ago

The contributing guide for the react-native-omh-auth repository is missing a crucial step for running pod install after setting up the project. This omission can lead to build failures when running yarn start or yarn workspace react-native-omh-auth-sample ios.

Steps to Reproduce:

  1. Clone the react-native-omh-auth repository.
  2. Follow the setup instructions in the contributing guide.
  3. Run yarn start or yarn workspace react-native-omh-auth-sample ios.

Actual Result: The build fails with errors such as:

error: unable to open configuration settings file
warning: Unable to read contents of XCFileList
error: Unable to load contents of file list

Possible Solution: For newcomers, this step might be easy to miss but is essential for the build process. Add the following step to the contributing guide after running yarn install:

  1. Navigate to the ios directory:
    cd apps/sample-app/ios
  2. Run pod install to install the required CocoaPods dependencies:
    pod install
  3. Continue with:
    yarn start

    or

    yarn workspace react-native-omh-auth-sample ios

Note (optional in contributing.md): Ensure CocoaPods is installed. If you encounter zsh: command not found: pod, install CocoaPods using:

sudo gem install cocoapods

Adding these instructions will prevent build errors due to missing CocoaPods dependencies and improve the onboarding experience for new contributors.

Thank you!

CC - @artus9033 in case this is also needed for maps.

andrei-zgirvaci commented 1 month ago

Hey @dzuluaga, thanks for bringing this to our attention! This has been addressed and should be fixed in https://github.com/openmobilehub/react-native-omh-auth/pull/65/commits/487847a876dd8608fc06b6a2a93c98db30d2a632.

dzuluaga commented 1 month ago

LGTM. Thanks, Andrei.