https://github.com/turskyi/politerai

Politer AI is a Compose Multiplatform mobile application that uses GPT-3.5, a powerful AI model, to make messages more polite and friendly.
https://github.com/turskyi/politerai

android compose compose-multiplatform desktop-application ios kmm kmp kotlin kotlin-multiplatform

Last synced: 16 days ago
JSON representation

Politer AI is a Compose Multiplatform mobile application that uses GPT-3.5, a powerful AI model, to make messages more polite and friendly.

• Host: GitHub
• URL: https://github.com/turskyi/politerai
• Owner: Turskyi
• Created: 2023-12-02T02:57:08.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-08T01:29:56.000Z (12 months ago)
• Last Synced: 2024-07-30T19:23:28.997Z (5 months ago)
• Topics: android, compose, compose-multiplatform, desktop-application, ios, kmm, kmp, kotlin, kotlin-multiplatform
• Language: Kotlin
• Homepage: https://www.politerai.com
• Size: 5.02 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)

# Politer AI

[![Codemagic build status](https://api.codemagic.io/apps/656e850f56b6e401cb0544dc/android-kmm-workflow/status_badge.svg)](https://codemagic.io/apps/656e850f56b6e401cb0544dc/android-kmm-workflow/latest_build)

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](https://kotlinlang.org/);

• SDK: [Android](https://developer.android.com/tools);

• Framework: [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/);

• Interface: [Compose](https://developer.android.com/jetpack/compose);

• HTTP client: [Ktor](https://ktor.io);

• Reactive programming: [Coroutines](https://developer.android.com/kotlin/coroutines);

• Version control system: [Git](https://git-scm.com);

• Git Hosting Service: [GitHub](https://github.com);

• CI/CD: [GitHub Actions](https://docs.github.com/en/actions) is used to deliver new Android

Package (APK) to [Firebase App Distribution](https://firebase.google.com/docs/app-distribution)

after every push to the **dev** branch, [Codemagic](https://codemagic.io/start/) is used to deliver

new release app bundle to **Google Play** after every push to **master** branch;

• App testing platforms:

[Firebase App Distribution](https://appdistribution.firebase.dev/i/353f302e0032e469);

• App store:

[Google Play](https://play.google.com/store/apps/details?id=com.turskyi.politerai);

• Operating system: [Android](https://www.android.com/);

• Architectural pattern:

[Monolith](https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/common-web-application-architectures#all-in-one-applications);

### 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](https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-multiplatform-getting-started.html)

by [JetBrains](https://github.com/JetBrains).