Skip to content

Teleport is an Android app built for testing deep link. Built with Jetpack Compose, Material Design 3, and modern Android architecture (MVVM + Hilt). Features smart link input, favorites system, and history tracking.

License

Notifications You must be signed in to change notification settings

jonathanlee06/Teleport

Repository files navigation

🚀 Teleport

Android Kotlin Jetpack Compose API License

A sleek and modern Android app for quick link management and deep link navigation

Join Beta

FeaturesScreenshotsTech StackBeta DownloadUsageContributing

Introduction


✨ Features

  • Smart Link Management - Quick input, history tracking, and favorites system
  • Modern UI - Material Design 3 with light/dark/system themes
  • Fast & Reliable - Instant launch, offline favorites, inline editing
  • WebView Integration - Browse links directly within the app
  • Deep Link Support - Handle custom URL schemes and app navigation
  • ** Customizable** - Theme preferences and app behavior settings

🛠 Tech Stack

  • Kotlin - Modern Android development language
  • Jetpack Compose - Modern declarative UI toolkit
  • MVVM + Hilt - Clean architecture with dependency injection
  • Material Design 3 - Latest design system and components
  • Navigation Component - Type-safe screen navigation
  • SharedPreferences - Local data persistence
  • Gradle Version Catalogs - Centralized dependency management

🚀 Beta Download & Installation

Clone & Build

  1. Clone the repository

    git clone https://github.com/jonathanlee06/Teleport.git
    cd teleport
  2. Open in Android Studio

    • Open Android Studio
    • Select "Open an existing project"
    • Navigate to the cloned directory
  3. Build the project

    ./gradlew assembleDebug
  4. Run on device/emulator

    • Connect your Android device or start an emulator
    • Click the "Run" button in Android Studio

Google Play (Closed Beta)

📱 Available on Google Play Store - Closed Beta Testing

Join the Beta Program

Note: This app is currently in closed beta. You'll need to join the beta program using the link above to download and test the app. Beta access may be limited.


📖 Usage

Getting Started

  1. Launch the app and you'll see the main screen with a link input field
  2. Enter any URL (e.g., https://github.com, market://details?id=com.app)
  3. Tap the link icon to open in WebView or star icon to save as favorite

Managing Favorites

  • Add to Favorites: Tap the star icon next to any link
  • View Favorites: Navigate to the Favorites screen from the main menu
  • Edit Links: Tap "Edit" on any favorite to modify the URL
  • Delete Items: Use "Delete" to remove individual favorites or "Clear All" for bulk deletion

Customization

  • Theme Settings: Go to Settings → Theme to choose Light, Dark, or System theme
  • Auto-save: Links are automatically saved to history as you use them

🤝 Contributing

We welcome contributions! Here's how you can help:

Ways to Contribute

  • 🐛 Bug Reports: Found a bug? Open an issue
  • Feature Requests: Have an idea? Share it with us
  • 🔧 Code Contributions: Submit a pull request
  • 📖 Documentation: Help improve our docs
  • 🌍 Translations: Add support for more languages

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is dual-licensed:

Code License

The source code is licensed under the Apache License 2.0 - see the LICENSE file for details.

Assets & Branding

Logo, branding, and visual assets are proprietary and copyright protected - see ASSETS.md for details.

Note for Contributors: When forking this project, please replace all branding assets with your own.


👨‍💻 Author

Jonathan Lee - GitHub Profile


🙏 Acknowledgments

  • Thanks to the Android team for Jetpack Compose
  • Material Design team for the amazing design system
  • Open source community for inspiration and tools

Star this repo if you find it helpful!

Made with ❤️ and ☕ by Jonathan

About

Teleport is an Android app built for testing deep link. Built with Jetpack Compose, Material Design 3, and modern Android architecture (MVVM + Hilt). Features smart link input, favorites system, and history tracking.

Topics

Resources

License

Stars

Watchers

Forks

Languages