Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

Get the source

Brian Clozel edited this page Jun 17, 2020 · 15 revisions

If you're familiar with forking/cloning repositories via GitHub, you can skip most of this page and just follow the normal procedure:

git clone git@github.com:spring-io/sagan.git

Once you've got the repository cloned, come back and see about next steps.

Goal

Download the source code for the Sagan reference application to your local machine.

Prerequisites

Depending on the option you choose below, you'll need a local Git or Subversion installation, or you can simply download and unpack a zip file. The choice is yours, but we recommend the Git-based approach.

Steps

The main repository for the Sagan application can be found at https://github.com/spring-io/sagan. You have a few options as to how to sync these sources to your local machine:

Option 1: Fork and clone using Git

The recommended approach is to fork and clone this repository using Git – this will allow you maximum freedom to make changes, commit and push them to your own repository, share with others, and issue pull requests.

If you've forked and cloned repositories on GitHub before, then you'll know what to do.

If this is your first time, or you don't yet have a GitHub account, we recommend you read and follow these instructions:

Tip: If you're not a fan of the command line, you may also want to look into GitHub's desktop clients for Mac and Windows.

In any case, the goal is to clone your fork of the main repository, which should look like this:

$ git clone git@github.com:$GHUSER/sagan.git

... where $GHUSER is your GitHub username.

Option 2: Clone the main repository using Git

If you do not wish to create your own fork of the repository, you can always clone the main repo directly:

$ git clone git@github.com:spring-io/sagan.git

Note: This approach does not require you to have a GitHub account; it only requires that you have Git installed.

Next steps

Complete the other steps in set up environment if you have not done so already. Then run the site locally. Browse the wiki to see what else is possible.