Studious Puddle

This is a Kotlin Multiplatform project targeting Desktop & Server.

Structure

• /composeApp is for code that will be shared across your Compose Multiplatform applications. It contains several subfolders:
  • commonMain is for code that’s common for all targets.
  • desktopMain is for code that’s for the desktop target.

Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, iosMain would be the right folder for such calls.

• /server is for the Ktor server application.

• /shared is for the code that will be shared between all targets in the project. The most important subfolder is commonMain. If preferred, you can add code to the platform-specific folders here too.

Functionality

Database

• Schema: Create a database schema to store the pets, pet stores and users.
• Redis serves as cache for JSON/NoSQL data

Server requires a running Redis instance at port 6379; since we use JSON we also need redis-stack

API Implementation

• Powered by Ktor framework
• TODO: Integrate SwaggerUI for OpenAPI

Testing

• Unit testing via JUnit
• Server testing: https://ktor.io/docs/server-testing.html
• TODO: https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-run-tests.html

Frontend

• Powered by Compose so it implements Material Design
• Is available for at least macOS desktop platform
• Talks to the API via HTTP
• Offers a UI for the Pet Catalog with a list and a detail-view
• TODO: The list view can be filtered with the given endpoints.
• TODO: Apply Dark vs. Light theme depending on OS preference

References

• PetStore API source: https://editor.swagger.io/?url=https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml
• DogAPI: https://dog.ceo/dog-api/
• Learn more about Kotlin Multiplatform
• Redis stack