Incomplete Setup Documentation for Facebook OMH Auth in React Native Sample App

[dzuluaga]

The current documentation for setting up Facebook OMH Auth in the React Native sample app is missing critical steps, making it extremely challenging for developers to understand the requirements and successfully run the app. The provided documentation links to general Facebook resources, which are not specific enough to guide through the specific setup needed for the OMH library integration.

Steps to Reproduce

1. Follow the existing setup instructions provided in the React Native sample app repository.
2. Attempt to configure Facebook OMH Auth based on the general Facebook documentation linked in the setup.

Expected Behavior

The setup instructions should clearly outline all necessary steps specifically tailored to the OMH library requirements, including:

• Detailed guidance on setting the hash ID.
• Instructions for configuring the package name and activity settings.
• Steps to include the required email scope.

Actual Behavior

The documentation provides only a general link to Facebook's documentation, which is too generic and not directly applicable to setting up the OMH library. As a result:

• Developers are left without clear instructions on how to set the hash ID.
• There is no specific guidance on setting package names and activity settings.
• The necessity to add the email scope is not clearly communicated.

Suggested Improvements

Please consider the following actions to enhance the documentation:

• Perform usability testing with developers unfamiliar with the process to identify and address gaps in the setup instructions.
• Update the documentation to include specific, step-by-step setup instructions tailored to the OMH library integration.
• Reference related issues such as Android Native App Issue #50 which highlights similar documentation shortcomings.

Additional Context

I spent several hours trying to configure the React Native sample app due to the incomplete setup documentation, indicating a clear need for more detailed guidance. It would greatly benefit the developer community to have these improvements made.

Thank you for your attention to this matter.

[andrei-zgirvaci]

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

[dzuluaga]

Thanks, Andrei, for clarifying the purpose of local.properties and .env for each provider; I'll leave the bug open for tracking, but I wonder if simplifying the duplication of these variables could help avoid the errors that come with maintaining two separate files.

[dzuluaga]

To add more context about potential confusion of using multiple files to keep track of dupped properties, This error states that I'm missing the value in .env, which is true, but why do I need to declare it twice? Since this should be a common pattern, what is your recommendation?

[andrei-zgirvaci]

Hey @dzuluaga, we require to store our secrets for the sample-app in an .env file, due to our CI/CD pipelines.

Regarding Android, we require developers to store their secrets inside the local.properties due to the already present logic in the android-omh-auth native library. It also allows developers to specify different secrets for Android and iOS.