Home

GitSync Beginner's Guide

Important

Prerequisite: Visit the GitHub signup page and create an account!

Creating a private repository

Note

If you already have an existing repository synced from another location, you can skip this step.

what is a repository?

We will be creating a new private repository on GitHub to hold the files you want to sync. While this offers a secure and private solution, keep in mind that no system is completely immune to determined attackers.

1. Log into your GitHub account.
2. Click your profile icon in the top right.

3. Select "Repositories" from the sidebar.

4. Click "New" to create a new repository.

5. Enter the repository details:
   • Name (required)
   • Description (optional)
   • No need to initialize with a README, add a .gitignore, or select a license.

• Click "Create repository".

You’re all set!

Cloning the repository on Android

The app will guide you through the setup process when you install it, for the most part. However, here are detailed instructions for key steps you need to have completed:

1. Authenticate with the default GitHub oAuth option
2. Select the repo you created in the previous step from the "Clone remote repository" list
3. Select a (or create a new) empty local directory to hold your synced files
4. (optional) Turn on auto sync when a particular app is opened or closed on the device