Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turskyi/malaknyzhka
Мала Книжка (Тарас Шевченко) – A Compose Multiplatform project celebrating Taras Shevchenko's poetry with authentic scanned book spreads.
https://github.com/turskyi/malaknyzhka
android compose-multiplatform kotlin
Last synced: 10 days ago
JSON representation
Мала Книжка (Тарас Шевченко) – A Compose Multiplatform project celebrating Taras Shevchenko's poetry with authentic scanned book spreads.
- Host: GitHub
- URL: https://github.com/turskyi/malaknyzhka
- Owner: Turskyi
- Created: 2024-12-22T02:54:02.000Z (14 days ago)
- Default Branch: master
- Last Pushed: 2024-12-22T20:44:15.000Z (13 days ago)
- Last Synced: 2024-12-22T21:31:24.853Z (13 days ago)
- Topics: android, compose-multiplatform, kotlin
- Language: Kotlin
- Homepage:
- Size: 457 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://stand-with-ukraine.pp.ua)
# Мала Книжка (Тарас Шевченко)
Welcome to "Мала Книжка (Тарас Шевченко)," a Compose Multiplatform project
designed to deliver a cohesive reading experience across Android, iOS, Web, and
Desktop. This project aims to celebrate the lyrical beauty of Taras Shevchenko's
poetry.
## PROJECT SPECIFICATION
• Programming language: [Kotlin](https://kotlinlang.org/);
•
Framework: [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/);
• SDK: [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html);
• Interface: [Compose](https://developer.android.com/jetpack/compose);
• Version control system: [Git](https://git-scm.com);
• Git Hosting Service: [GitHub](https://github.com);
• **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.
• Architectural pattern:
[Monolith](https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/common-web-application-architectures#all-in-one-applications);
## Project Structure
- **`/composeApp`**: Contains shared code for the Compose Multiplatform
applications.
- **`commonMain`**: Houses the common code for all targets.
- **Platform-specific folders** (e.g., `iosMain`, `androidMain`): These
contain code for specific platforms like CoreCrypto for iOS in the
`iosMain` folder.
- **`/iosApp`**: Contains the iOS applications. Despite sharing UI code, this
serves as the entry point for the iOS app and can include Swift/SwiftUI code
if needed.
## About the Project
### Overview
"Мала Книжка (Тарас Шевченко)" is a digital collection of Taras Shevchenko's
works, offering a seamless reading experience with draggable dividers and
elegant page transitions. It supports multiple platforms through Compose
Multiplatform, sharing a unified codebase.
### Features
- **Platform Support**: A single codebase approach for Android, iOS, Web, and
Desktop.
- **Interactive UI**: Draggable dividers allowing users to switch between text
and images effortlessly.
- **Swipe Gestures**: Smooth page transitions with horizontal drag gestures.
- **Multilingual Support**: Access Shevchenko's poetry in its native language.
- **Authentic Scans**: Includes scanned book spreads of the original "Мала
Книжка" with the actual handwriting of Taras Shevchenko, offering a glimpse
into the early Ukrainian language and script.
## Credits
This project utilizes book spreads and texts from the website
[t-shevchenko.name](https://www.t-shevchenko.name/uk/Gallery/Works/1850MalaKn.html).
The site's creators kindly allow reproduction with proper referencing. *
*Передрук статей із сайту заохочується за умови посилання (гіперпосилання) на
наш сайт**. Many thanks for their valuable contributions.
## Getting Started
To get started, ensure you have the necessary development environments for each
target platform. For detailed guidelines, refer to the following:
- [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)
- [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform)
- [Kotlin/Wasm](https://kotl.in/wasm/)
### Building and Running the Project
Build and run the web application using this Gradle task:
```bash
./gradlew :composeApp:wasmJsBrowserDevelopmentRun
```
## How to Contribute
We welcome contributions to enhance this project. Here’s how you can contribute:
- **Report Issues**: Encountered a bug or have a suggestion? Report issues
on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues).
Enjoy the poetic journey! 🌟