ShTP Mobile Client

🇬🇧 English 🇷🇺 Russian

About

• This is an Android client developed as a REST API client for the Back-End server.
• Connection to the server is made using compressed data exchange via the Protocol Buffers protocol, unlike the FrondEnd server, which is necessary to be always online even with a bad internet connection. (JSON can be easily switched to ProtoBuf)
• RxJava3 + Retrofit2 are used to exchange messages, which allows executing requests asynchronously.
• The user interface is based on the Figma design

Example of the alpha version of the application

Build

By default, the project is built with every git push request and sent to releases. The dedicated endpoint used is shtp.1561.ru

Manual application build:

• Change Backend-API address at app/src/main/kotlin/ru/slavapmk/shtp/Values.kt:

  const val ENDPOINT_URL = "YOUR_URL_HERE"

• Install Java 18, Amazon Correto may be suitable

• Set the path to the Java bin folder in the JAVA_HOME environment variable

• Run ./gradlew build --no-daemon in the project folder

• The compiled APK file is located in the app/build/outputs/apk/debug folder.