https://github.com/avan1235/shin

Kotlin Multiplatform implementation of URL Shortener that compiles to native code on all platforms from single codebase
https://github.com/avan1235/shin

android ios kotlin linux macos multiplatform qrcode shortener url windows

Last synced: about 10 hours ago
JSON representation

Kotlin Multiplatform implementation of URL Shortener that compiles to native code on all platforms from single codebase

• Host: GitHub
• URL: https://github.com/avan1235/shin
• Owner: avan1235
• License: mit
• Created: 2024-02-03T19:20:38.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-14T19:58:59.000Z (3 months ago)
• Last Synced: 2024-08-14T21:19:06.013Z (3 months ago)
• Topics: android, ios, kotlin, linux, macos, multiplatform, qrcode, shortener, url, windows
• Language: Kotlin
• Homepage: https://sh.procyk.in
• Size: 5.52 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Shin

[![Platforms](https://img.shields.io/badge/web-WebAssembly-blue)](https://sh.procyk.in)

[![Platforms](https://img.shields.io/badge/mobile-Android%20%7C%20iOS-blue)](https://github.com/avan1235/shin/releases/latest)

[![Platforms](https://img.shields.io/badge/desktop-Windows%20%7C%20macOS%20%7C%20Linux-blue)](https://github.com/avan1235/shin/releases/latest)

[![Build](https://img.shields.io/github/actions/workflow/status/avan1235/shin/release.yml?label=Build&color=green)](https://github.com/avan1235/shin/actions/workflows/release.yml)

[![Latest Release](https://img.shields.io/github/v/release/avan1235/shin?label=Release&color=green)](https://github.com/avan1235/shin/releases/latest)

[![Docker](https://img.shields.io/docker/v/avan1235/shin?label=Docker%20Hub&color=green)](https://hub.docker.com/repository/docker/avan1235/shin/tags?ordering=last_updated)

[![Google Play](https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Din.procyk.shin%26l%3DGoogle%2520Play%26m%3D%24version)](https://play.google.com/store/apps/details?id=in.procyk.shin)

[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](./LICENSE.md)

[![GitHub Repo stars](https://img.shields.io/github/stars/avan1235/shin?style=social)](https://github.com/avan1235/shin/stargazers)

[![Fork Shin](https://img.shields.io/github/forks/avan1235/shin?logo=github&style=social)](https://github.com/avan1235/shin/fork)

## Download and run application

### Download compiled application

#### Google Play

Latest Android version is available on

[Google Play](https://play.google.com/store/apps/details?id=in.procyk.shin).



#### GitHub Releases

You can download compiled version of application from

[GitHub Releases](https://github.com/avan1235/shin/releases).

You can find the compiled vesion of the application for Android, Linux, macOS and Windows.

Please note that for running unsigned version of macOS application, you need to temporarily

disable Gatekeeper, so after installing the application run

```shell

sudo xattr -dr com.apple.quarantine  /Applications/Shin.app

```

in the terminal. You can learn more about this

[here](https://web.archive.org/web/20230318124537/https://disable-gatekeeper.github.io/).

To install Linux version run:

```shell

sudo dpkg -i  shin.deb

```

### Build application locally

The project is configured with with Gradle and you can find the

latest release build commands in the [release.yml](./.github/workflows/release.yml) file.

How to build particular platforms:

- Android & iOS: use run configurations provided by [Fleet](https://www.jetbrains.com/fleet/) to run locally

- desktop: `make desktop`

- wasm: `make wasm`