README.md

Politer AI

This is a Kotlin Multiplatform project targeting Android, iOS, Desktop. Kotlin Multiplatform is a broad technology that enables cross-platform development with Kotlin.

PROJECT SPECIFICATION

• Programming language: Kotlin;

• SDK: Android;

• Framework: Compose Multiplatform;

• Interface: Compose;

• HTTP client: Ktor;

• Reactive programming: Coroutines;

• Version control system: Git;

• Git Hosting Service: GitHub;

• CI/CD: GitHub Actions is used to deliver new Android Package (APK) to Firebase App Distribution after every push to the dev branch, Codemagic is used to deliver new release app bundle to Google Play after every push to master branch;

• App testing platforms: Firebase App Distribution;

• App store: Google Play;

• Operating system: Android;

• Architectural pattern: Monolith;

Folder structure

• /composeApp is for code that is shared across Compose Multiplatform applications. It contains several subfolders:
  • commonMain is for code that’s common for all targets.
  • Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
• /iosApp contains iOS applications.

Compose Multiplatform is a focused library that enables cross-platform UI development with Jetpack Compose.

• Code Readability: code is easily readable with no unnecessary blank lines, no unused variables or methods, and no commented-out code, all variables, methods, and resource IDs are descriptively named such that another developer reading the code can easily understand their function.

• Screenshots:

Credits

This project is based on the Get started with Compose Multiplatform — tutorial by JetBrains.