x

Main chapters

  1. LimeSurvey Cloud vs LimeSurvey CE
  2. LimeSurvey Cloud - Quick start guide
  3. LimeSurvey CE - Installation
  4. How to design a good survey (Guide)
  5. Getting started
  6. LimeSurvey configuration
  7. Introduction - Surveys
  8. View survey settings
  9. View survey menu
  10. View survey structure
  11. Introduction - Questions
  12. Introduction - Question Groups
  13. Introduction - Surveys - Management
  14. Survey toolbar options
  15. Multilingual survey
  16. Quick start guide - ExpressionScript
  17. Advanced features
  18. General FAQ
  19. Troubleshooting
  20. Workarounds
  21. License
  22. Version change log
  23. Plugins - Advanced
 Actions

Accessing the source code: Difference between revisions

From LimeSurvey Manual

No edit summary
 
mNo edit summary
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__TOC__


===Accessing the LimeSurvey v1/v2 Source Code===
=General=


Always be aware that LimeSurvey Source code is '''bleeding edge'''. Do not use it for production purposes!
Until recently we used Subversion as versioning control system but now have [[Switch from Subversion to Git|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.
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.
Access the LimeSurvey source code with a Subversion client for your operating system.
*For Windows we recommend: [http://tortoisesvn.sourceforge.net/ TortoiseSVN]. TortoiseSVN integrates nicely with explorer and is very easy to use.
*For Windows we recommend: [http://www.syntevo.com/smartgit/download.html SmartGit] because it is very easy to use.
*For Mac we recommend: [http://subversion.tigris.org/project_packages.html subversion]. Commandline all the way ;)
*For Linux & Mac we recommend: [http://git-scm.com/ Git]. Commandline , or use git gui, very easy too.
 
==Step-by-Step How-To (Windows)==
# Create a [https://github.com/ GitHub] account.
# Download and install Git for Windows from [http://code.google.com/p/msysgit/downloads/list]. 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 [http://help.github.com/win-set-up-git/ Set Up Git]
# Download and install [http://www.syntevo.com/smartgit/download.html SmartGit].
# Clone the LimeSurvey repository with SmartGit. You can find the right clone URL at https://github.com/LimeSurvey/LimeSurvey .
# The whole source code repository should be downloading now.
# By default you should see the 'master' branch in the current directory
# Use the Switch command from the SmartGit GUI to switch to the branch you need.
# That's it.
 
==Step-by-Step How-To (Linux)==
 
=== Read-only mode===
# Install via yum/apt/yahourt/... git and git-core
# Clone LimeSurvey in ReadOnly mode : <syntaxhighlight lang="bash" >git clone git://github.com/LimeSurvey/LimeSurvey.git</syntaxhighlight>
# By default you should see the 'master' branch in the current directory
# To set to dev (Yii branch actually)<syntaxhighlight lang="bash" >cd LimeSurvey


===Step-by-Step How-To (Windows)===
git checkout Yii</syntaxhighlight>
#Download and install [http://tortoisesvn.sourceforge.net/ TortoiseSVN]. Reboot after install.
# To get the update from LimeSurvey:<syntaxhighlight lang="bash" >cd LimeSurvey
#Create a destination directory for the source
#Change to that directory
#Right-click into the directory and choose ''''SVN Checkout''''
#You'll be prompted for the repository URL. Enter the following URL:
## For LimeSurvey 1.x latest stable source (including fixes): https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey
## For LimeSurvey 1.x latest development source (unstable, including newer features): https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey_dev
## For LimeSurvey 2.x source: https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey20
#That's it. The source code should be downloading now.


===Step-by-Step How-To (Mac, Linux, Unix)===
git pull</syntaxhighlight>
# Download and install [http://subversion.tigris.org/project_packages.html subversion].
# From a terminal window navigate to a directory that you would like to checkout the code to
# Type one of the following into the terminal:


+For LimeSurvey 1.x source:
=== Start your own branch ( Fork )===
#  For LimeSurvey 1.x latest stable source (including fixes):
# See the complete instrtuction in GitHub : http://help.github.com/fork-a-repo/


+svn co https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey
Please add instructions for other OSs or complete the existing ones.
# For LimeSurvey 1.x latest development source (unstable, including newer features):


+svn co https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey_dev
=Available branches=


+For LimeSurvey 2.x source:
These are the available GitHub branches right now:
** svn co https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey20/limesurvey
*master - This is always the current stable (plus) version including any fixes not yet released.
** svn co https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/source/limesurvey20/limesurvey-dev/
*original_art and original_art 2: These are the SVG files for almost all icons the stable and Yii version.
# Once the checkout is complete there will be a folder named 'limsurvey' (or dir_name) in your current terminal working directory containing the source.
*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.


===Accessing Old Releases===
=Further documentation=


Old releases are stored in https://limesurvey.svn.sourceforge.net/svnroot/limesurvey/releases .
Please make sure you code accoding to our [[Coding guidelines]].

Latest revision as of 14:55, 16 February 2022

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.

Retrieved from "http://www.limesurvey.org/manual/index.php?title=Accessing_the_source_code&oldid=172051"