Samagra-Development / odk-collect-extension

ODK Collect is an Android app for filling out forms. ODK Collect Extensions is a layer on top of ODK Collect to make it easier to integrate inside existing Android apps.
https://docs.getodk.org/collect-intro
Apache License 2.0
5 stars 18 forks source link

Added an Initial-Setup Guide with all the required steps that are required by a contributor to have a local setup running. #58

Closed prabs3257 closed 1 year ago

prabs3257 commented 1 year ago

Added an Initial-Setup Guide with all the required steps that are required by a contributor to have a local setup running. Made changes to AndroidManifest.xml of the sample app to ensure that the app trusts the locally added CAs.

Closes #59

What has been done to verify that this works as intended?

Tested and debugged the sample app thoroughly to ensure that no error comes up during the initial local setup

Why is this the best possible solution? Were any other approaches considered?

There were other approaches that involved the use of external programs like ngrok to get a public domain. But this solution ensures that the setup depends on minimum external programs. This solution also enhances the local endpoints by making them secure

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

These changes will not affect the user. Just the contributors who want to have a local setup of the project.

Do we need any specific form for testing your changes? If so, please attach one.

NO

Does this change require updates to documentation? If so, please file an issue here and include the link below.

I have made the required changes

Before submitting this PR, please make sure you have:

prabs3257 commented 1 year ago

@chinmoy12c Made the requested changes. Please review it at your earliest convenience.