kisa002/transer

Translation utility for mac, windows, android developed based on the Kotlin Multiplatform (Compose Desktop).

TRANSER for easy and fast translation

What is TRANSER

One-line summary

TRANSER is an application built for easy and fast translation.

How can it be easy and faster than this?

Why did I make it?

I created this project to solve the inconvenience of using a translator when people like me read other language documents and see words or sentences that they don't know.

This project started on January 2nd, 2023.

Kotlin Multiplatform

TRANSER is developed based on the Kotlin Multiplatform, so many logic are shared like UI, API, Database, etc.

I think the Kotlin Multiplatform is more powerful than other cross-platforms when requiring native platform features, so I focused on shared logic but also the features of each native platform.

How to use it?

Desktop

It's simple, just type it in the TRANSER then it is translated.

If your platform is mac, you can use a shortcut (⌥ + Space) to appear on the top while running TRANSER. Or other platforms, you can use Control + Space.

Currently, mac is safety version. windows, linux required to more test.

Android

TRANSER automatically translates text when you select the text and click TRANSER in the menu that comes out.

iOS

Just enter text in the app and it will be automatically translated.

Captures

Desktop

• Onboarding

  

• Translate & Recent & Saved

  

• Preferences

  

• Light Theme

  

Android

• Translate

  

• Recent

  

• Saved

  

• Preferences

  

• Light Theme

  

iOS

• Translate

transer-ios-translate.MP4

• Recent

transer-ios-recent.MP4

• Saved

transer-ios-saved.MP4

• Preferences

transer-ios-preferences.MP4

• Theme

transer-ios-dark.MP4

Features

• Common
  • Translate
  • Recent Translate
  • Saved Translate
  • Preferences
  • Support dark/light theme
  • API
  • Database
• Native
  • Desktop
    • Shortcut
    • Commands
    • Onboarding (Will be supported the Android)
  • Android
    • Detect text event (click TRASER in the menu that showed up on long-press select text in other apps)

Architecture

• Architecture
  • Bob’s Clean Architecture
  • MVVM Design Pattern

Shared Logic

• Data
  • Model
  • Remote
    • Translate
    • Detect
    • Languages
  • Local
    • Preferences
    • Recent Translate
    • Saved Translate
• Domain
  • Model (All platforms use the same model)
  • Repository
    • Remote
      • Translate
      • Detect
      • Languages
    • Local
      • Preferences
      • Recent Translate
      • Saved Translate
  • UseCase
• Presentation
  • Theme
    • Color
    • Font
  • Screen
    • Preferences
  • Component
    • Header
    • RainbowCircularProgressIndicator

Native Logic

• Desktop
  • Translate flow
    • Desktop flow is like the mac spotlight.
  • Shortcut
    • with JNativeHook
  • Onboarding
• Android
  • Translate flow
    • Mobile flow is like a bottom sheet that showed up on dragging the text and clicking the menu.

Libraries

• Common (aka. Kotlin Multiplatform Library)
  • Ktor
  • SQLDelight
• Native
  • Desktop
    • JNativeHook
  • Android
    • Material-icons-extended

Todos

• Common
  • Separate data-domain-presentation module (currently, just separated in the same package)
  • Cache translate API result
  • Multilingual support (TRANSER UI)
• Native
  • Desktop
    • Test Linux
    • Onboarding (User try it self)
  • Android
    • Onboarding
  • Server
    • API Server
    • Analytics
  • Web
    • Landing Page
    • Preview translation for desktop

License

MIT License

Copyright (c) 2023 kisa002

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

transer's Issues

ReadMe gifs