Create "starter-code" branch with a minimal app for easier development

[dzuluaga]

Description: During the code review (https://github.com/openmobilehub/omh-maps/pull/73#discussion_r1207183513) and discussions on Slack (https://omh-co.slack.com/archives/D051AEWK7J5/p1685478848638529) on May 31st, it was agreed upon to create a "starter-code" branch in the repository with a minimal app. This branch would provide developers with a clear and simplified set of steps to follow.

Currently, the repository lacks a "starter-code" branch and a minimal app, making it challenging for developers to get started quickly. To address this issue, I propose the following changes:

1. Create a new branch named "starter-code" in the repository (https://github.com/openmobilehub/omh-maps.git).
2. In the "starter-code" branch, include a minimal sample app that demonstrates the essential functionality of the project.
3. Update the "Getting Started" guide to include a step instructing developers to clone the repository using the following command:

   git clone --branch starter-code https://github.com/openmobilehub/omh-maps.git

4. Remove the unnecessary steps related to the existing sample app from the "Getting Started" guide, as they will be covered by the new "starter-code" branch.
5. To reduce the noise of additional frameworks, remove the Hilt framework from the "starter-code" branch.
6. Test the "Getting Started" steps from beginning to end, ensuring that they can be executed without encountering any failures or issues.

By implementing these changes, developers will have access to a clear and minimal starting point, allowing them to follow the provided steps more easily. This will enhance the onboarding process and improve overall developer experience with the project.

Thank you for considering this bug report, and please let me know if you need any further information or clarification.

CC - @rquino @prestonlau @itsme291

[hans-hamel]

Just to be sure. What will be the naming convention of the starter sample? e.g. Namespace: com.omh.android.maps.starter.sample Packages: com.omh.android.maps.starter_sample Module name: maps-starter-sample

[dzuluaga]

To maintain consistency, it's important that we stick to the same naming conventions as the sample app. This means that the starter-code branch should mirror the final app. Our goal is for users to have the same functionality as the sample app once they complete the getting started steps.

[dzuluaga]

@hans-hamel

First of all, thank you for your work on the branch. I appreciate your efforts.

However, upon reviewing the code, I noticed that there are some unnecessary components included. As we discussed earlier, the "starter-code" branch should contain minimal code. Specifically, I see that the "maps-api", "maps-api-google-maps", and "maps-api-openstreetmap" modules have been included. These modules are not required for this sample app, as it should be independent and targeted towards the staging or release area of Maven Central.

Could you please provide some context as to why these modules were included? If there is a valid reason, please let me know. Otherwise, I kindly request that you remove these modules from the "starter-code" branch.

Thank you for your attention to this matter.

[dzuluaga]

Friendly ping, @hans-hamel

[dzuluaga]

@nelsonwilches Can we get an update on this one? Thanks!

[dzuluaga]

Cleaning up old issues.