Accessing the source code

From LimeSurvey Manual
Jump to: navigation, search

Contents


General

Until recently we used Subversion as versioning control system but now have moved to Git.

Accessing the LimeSurvey source code

Always be aware that most of the LimeSurvey Source code is bleeding edge. Do not use it for production purposes (except fo the master branch!

As for many other free software projects only community support is available.

Access the LimeSurvey source code with a Subversion client for your operating system.

  • For Windows we recommend: SmartGit because it is very easy to use.
  • For Linux & Mac we recommend: Git. Commandline , or use git gui, very easy too.

Step-by-Step How-To (Windows)

  1. Create a GitHub account.
  2. Download and install Git for Windows from [1]. Make sure that during install when asked for adding the Git path to your system path that you choose the "Run Git from the Windows Command Prompt" option. For further help see Set Up Git
  3. Download and install SmartGit.
  4. Clone the LimeSurvey repository with SmartGit. You can find the right clone URL at https://github.com/LimeSurvey/LimeSurvey .
  5. The whole source code repository should be downloading now.
  6. By default you should see the 'master' branch in the current directory
  7. Use the Switch command from the SmartGit GUI to switch to the branch you need.
  8. That's it.

Step-by-Step How-To (Linux)

Read-only mode

  1. Install via yum/apt/yahourt/... git and git-core
  2. Clone LimeSurvey in ReadOnly mode :
    git clone git://github.com/LimeSurvey/LimeSurvey.git
  3. By default you should see the 'master' branch in the current directory
  4. To set to dev (Yii branch actually)
    cd LimeSurvey

    git checkout Yii
  5. To get the update from LimeSurvey:
    cd LimeSurvey

    git pull

Start your own branch ( Fork )

  1. See the complete instrtuction in GitHub : http://help.github.com/fork-a-repo/

Please add instructions for other OSs or complete the existing ones.

Available branches

These are the available GitHub branches right now:

  • master - This is always the current stable (plus) version including any fixes not yet released.
  • original_art and original_art 2: These are the SVG files for almost all icons the stable and Yii version.
  • other_scripts, server_scripts, translation status: These are scripts being used in limesurvey.org or for new releases. We will merge these to a single 'server-scripts' branch soon.

Further documentation

Please make sure you code accoding to our Coding guidelines.