Setup of Development environment

Required software

• Git (see also some Notes about Git)
• Microsoft .Net 2.0 Redistributable and SDK
• SharpDevelop 3.0
• NAnt (see also some Notes about NAnt)
• one of the follwoing Database Management systems:
  • PostgreSQL (recommended) Notes about PostgreSQL
  • MySQL Notes about MySQL
  • no installation effort at all is required for SQLite
• Poedit (for translation) (see also Notes about I18N)
• Mono (for translation)
• Inno Setup 5 for building setup files

Get the source code

The source code is managed with Git. You can get the source code in several ways:

• see the Git instructions at Sourceforge
  • that page describes how you can download anonymously from Git
• you can also browse the Git repository online, and you can download a tar.gz snapshot there
• the latest release should also provide a download of the source files, see Download section

Git with write permission

Create an empty repository like this, and create a disk drive on that directory (this is useful if you want exactly the same setup as everybody else; you can choose the part of c:\OpenPetra yourself, but U:\ will always be the same; alternatively see below how to change the OpenPetra.build file)

 mkdir c:\OpenPetra
 subst u: c:\OpenPetra

Make a local copy of the git repository (these are the commands for Git Bash; TortoiseGit also works fine for me):

cd u:
mkdir OpenPetra
cd OpenPetra
git clone ssh://USERNAME@openpetraorg.git.sourceforge.net/gitroot/openpetraorg
git config user.name "YOUR NAME"
git config user.email "USERNAME@users.sourceforge.net"

Build the code

• there is a central NAnt script that is able to generate a lot of code and is able to do all automated tasks in the OpenPetra project.
• you need to make a copy of the file OpenPetra.build-sample.config and call it OpenPetra.build.config
  • you might need to either change the directory paths, or alternatively you can create a virtual U: drive on the command line:

subst u: "c:\my files\unzippedOpenPetra"

get help

To see the available commands, just run on the command line:

cd OpenPetra
nant help

initial steps

First you need to compile the PetraTools which is a set of programs for creating databases and more:

nant compileCommon
nant compilePetraTools

Now you need to create a database. If you don't change the config file, the SQLite database system will be used.

nant recreateDatabase

Then you want to load the database with base data:

nant resetDatabase

You should compile OpenPetra.org this way:

nant compilePetra

Start the OpenPetra.org Server:

nant startPetraServer

Start the OpenPetra.org client:

nant startPetraClient

With the base database, there is the user demo with password demo that you can use to login to your installation of OpenPetra.org.

See Preview: Current functionality for information what is actually working already.

Stop the OpenPetra.org Server:

nant stopPetraServer

todo

• generate files for translation (gettext, Poedit)