Skip to content

Android mobile git client for syncing a repository between remote and a local directory

License

Notifications You must be signed in to change notification settings

ViscousPot/GitSync

Repository files navigation

GitSync

Android git client for syncing a repository between remote and a local directory

license last commit stars downloads sponsor


Get it on Google Play    Get it on Izzy On Droid


Documentation


GitSync is an Android git client that aims to simplify the process of syncing a folder between a git remote and a local directory. It works in the background to keep your files synced with a simple one-time setup and numerous options for activating manual syncs

  • Supports Android 5+
  • Authenticate with
    • GitHub
    • Gitea
    • HTTP/S
    • SSH
  • Clone a remote repository
  • Sync repository
    • Fetch changes
    • Pull changes
    • Commit new changes
    • Push changes
    • Resolve merge conflicts
  • Sync mechanisms
    • From a quick tile
    • When an app is opened or closed
    • From a custom intent (advanced)
  • Settings
    • Customise sync message
    • Edit .gitignore file

Give us a ⭐ if you like our work. Much appreciated!

Build Instructions

If you just want to try the app out, feel free to use a pre-built release from the Releases page

1. Setup

  • Clone the project
  git clone https://github.com/ViscousPot/GitSync.git
  • Go to the project directory
  cd GitSync
  • Open the project in Android Studio
  • Sync the gradle project

2. Secrets

  • Rename Secrets.kt.template to Secrets.kt
  • Visit https://github.com/settings/developers
  • Select OAuth Apps
  • Select New OAuth App
    • Application Name: GitSync
    • Homepage URL: https://github.com/ViscousPot/GitSync
    • Authorization callback URL: gitsync://auth
    • Enable Device Flow: leave unchecked
  • Fill Secrets.kt with the new OAuth App ID and SECRET

3. Build & Run

  • Build from within Android Studio

Support

For support, email [email protected].

Consider sponsoring! Any help is hugely appreciated!

Authors

Acknowledgements