rustamsafarovrs / inmuslim-android

Inmuslim Android source

Inmuslim

This repo contains the official source code for Inmuslim App for Android.

Install

If you're just looking to install Inmuslim, you can find it on Google Play.

Compilation Guide

You will require Android Studio Giraffe (2022.3.1) and Android SDK 33

1. Download the Inmuslim source code from https://github.com/rustamsafarovrs/InmuslimAndroid ( git clone https://github.com/rustamsafarovrs/InmuslimAndroid.git ).
2. Copy your release.keystore into app/config.
3. Fill out RELEASE_KEY_PASSWORD, RELEASE_KEY_ALIAS, RELEASE_STORE_PASSWORD in local.properties to access your release.keystore.
4. Open the project in the Studio (note that it should be opened, NOT imported).
5. You are ready to compile project.

Technologies

Core

• Kotlin
• Jetpack Compose (UI & navigation)
• MVVM architecture with Flow
• Hilt (DI)
• Kotlin Coroutines

Networking

• Retrofit (REST API)
• OkHttp 3 (REST client)
• Moshi (JSON serialization)

Local Persistence

• Shared Preferences

Other

• Firebase Crashlytics (crashes, logging)

CI/CD

Soon...

Project Requirements

• Java 17
• Android Studio Giraffe (2022.3.1) (for easy download - JetBrains Toolbox)

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

Documentation

• Pull Request Guidelines - branch naming and how to write good pull requests.