feat: setup project scheleton

[ilkeraslan]

• Create shared module to manage shared logic via Kotlin Multiplatform.
• Create android module for Android app.

[fardavide]

Thank you for your contribution!

I have a few notes about the changes, based on some concepts we agreed upon, and I would like to take the opportunity to improve the readme, to add guidelines, and facilitate future contributions, but also give a chance to speak out to those who didn't participate to the previous discussions! 🙂

Conventional commits

We agreed that every commit message should follow the conventional commits guidelines; for example, Add shared and android modules should be chore: add shared and android modules - note the prefix chore: and the de-capitalized sentence.

Running the tunes.sh scripts once should add the pre-commit hooks to your project so that you would receive an error with a message, in case the commits message doesn't match the defined pattern.

Build system (Gradle)

We agreed to use Groovy, over KScript (.kts), in order to keep the maximum of performance for Gradle.

In order to keep the modules' configuration accessible and coherent, we completely rely on our conventional plugins located into build-tools to configure our modules: for example, the iOS targets initialization should be done by the MultiplatformPlugin.

Compose and resources

We agreed to use Jetpack Compose, so in my opinion, we should not add various layouts and XMLs, including also the icons.

[fondesa]

Maybe I have missed something but why do we need a project skeleton?
Shouldn't we start adding directly our features/real modules?

If the purpose of the skeleton is just creating a sample where we can try out things, I think the right location should be :playground.

[fardavide]

Maybe I have missed something but why do we need a project skeleton?
Shouldn't we start adding directly our features/real modules?

This is also a very valid point that I haven't been able the highlight

[ilkeraslan]

Maybe I have missed something but why do we need a project skeleton? Shouldn't we start adding directly our features/real modules?

If the purpose of the skeleton is just creating a sample where we can try out things, I think the right location should be :playground.

My goal was to have a starting point for the feature modules that we are still discussing. It came to my understanding that we haven't decided yet which are our main features, so in the meantime I see this as an opportunity to setup the base structure.

If the PR is not appropriate or if we know which feature modules that we should have, I can close or modify it without any problem.