Skip to main content
Using Sympli Versions with GitHub

Connect Versions with GitHub

Max Ignatyev avatar
Written by Max Ignatyev
Updated over 3 years ago

Signing up with a GitHub account

After you install and run Sympli Versions desktop application, then choose GitHub as a Sign In option.

You will be redirected to GitHub to authorize Sympli Versions application to access your account.

Connecting your GitHub account to an existing Versions account

In case you already have an account, go to your Account Settings and click “Sign in with GitHub”.

You will be redirected to GitHub to authorize Sympli Versions application to access your account, and your GitHub account will be linked to your Versions account.

Creating GitHub-stored project in Versions

Projects in Sympli Versions look and feel like a regular folder, while under the hood it’s connected to an actual version control system.

To create a project, in a new project dialog fill in the name of the project. By default, your projects will be stored in your ~/Versions folder.

Select GitHub as a service to store your files at, and choose a team (if any) to own the project. For paid GitHub subscribers, there is an option to make the project private.

Working with projects

To start working with the project, open a working directory with “Reveal in Finder” option from the kebab menu on a project card.

Then, move your Sketch mockups to the working folder. Once you do that, you’ll notice that files now have a status indicators, which are described below.

File statuses

Publishing updates to GitHub

First, you need to make sure your files are tracked. To do so, select a file with ? status in Finder, and in the context menu select “Add File”.

Then, provide some context on what this mockup is for or what you were working on and hit “Upload Files”.

Congratulations! Your mockup is now published, so you can collaborate on it with your team.

Sharing with your Team

Open "Members" tab in the project’s dashboard, and then click on “Manage in Web App”. At the moment, team management is only available there.

In the web app, you can invite new team members via email and set their access level (Read-only, Write, or Admin) using “Share Project” button:

Did this answer your question?