Lingshot is a simple yet powerful screenshot capture tool that makes multilingual communication more accessible than ever before. With this app, you can take a screenshot of any text you come across and instantly translate it into your preferred language.

Key Features:

📸 Easy Screen Capture: Quickly take a screenshot of any text on your device.

🔍 Automatic Text Recognition (OCR): The built-in OCR automatically recognizes text in your screenshots.

🌐 Instant Translation: Translate recognized text with just a tap.

💬 ChatGPT Integration: Our app leverages the powerful AI of ChatGPT for translation and context enhancement when needed.

🔒 Privacy Guaranteed: We value your privacy and ensure that your screenshots and translations remain secure and confidential.

This project's primary focus is to promote a modular, scalable, maintainable, and testable architecture. It incorporates a cutting-edge tech stack and embodies the best practices in software development. While the application may seem straightforward, it encompasses all the essential components that form the foundation for a robust, large-scale application.

The design principles and architectural choices applied in this project are ideally suited for larger teams and extended application lifecycles. This application not only showcases functionalities but also serves as a testament to how well-structured and well-written code acts as a stable backbone for scalable and maintainable software development projects.

The Lingshot app follows the official architecture guidance.

You'll need to add the OpenAI and Google Cloud API keys, but the latter is optional.

• OpenAI API Key:

  1. Head to OpenAI Developer.
  2. Sign up and create a new project.
  3. Retrieve your API key from project settings.

• (OPTIONAL) Google Cloud API Key:

  1. Visit Google Cloud Console.
  2. Create or select your project.
  3. Navigate to "APIs & Services" > "Credentials."
  4. Generate a new API key, ensuring to set restrictions for security.

In your project directory, in the lingshot-keys file:

CHAT_GPT_KEY = "<Your_OpenAI_API_Key>"
GOOGLE_TRANSLATE_KEY = "<Your_Google_Cloud_API_Key>_(OPTIONAL)"

Replace <Your_OpenAI_API_Key> with your actual API key.

This project takes advantage of best practices, and many popular libraries and tools in the Android ecosystem.

• Tech-stack
  • Kotlin
    • Coroutines
    • Kotlin Flow
    • Kotlin Symbol Processing
    • Kotlin Immutable Collections
  • Retrofit
  • Jetpack
    • Lifecycle
    • ViewModel
  • Hilt
  • Coil
  • Lottie
• Modern Architecture
  • Single activity architecture
  • MVVM
  • Clean Architecture
  • Android Architecture components (ViewModel , Kotlin Flow , Navigation)
  • Android KTX
• UI
  • Jetpack Compose
  • Material Design 3
    • Dark Theme
    • Dynamic Theming
• ML Kit
  • Text Recognition
  • Text Speech
  • Language Identification
• CI
  • GitHub Actions
  • Danger System
• Testing
  • Paparazzi Snapshot
  • Test Parameter Injector
• Static analysis tools (linters)
  • Detekt
  • Spotless
  • Compose Rules
  • Compose Lints
• Gradle
  • Gradle Kotlin DSL
  • Versions catalog
  • Type safe accessors
• GitHub Boots
  • Renovate
• Other Tools
  • Image Cropper
  • Telephoto Zoomable
  • Balloon Compose
  • Markdown Compose
  • Chucker Proxy

Copyright 2023 Lingshot

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.