User Tools

Site Tools


contributorguide:preparerunningenvironment

Step 1 : create sample data in your local database

Now you should have a PostgreSQL server installed. To be able to test your development with Sigmah, you will need to add sample data to your database (mainly, an organization). This can be done through a simple call to the SQL function create_new_organization .

Call this function on your database. You can use command psql -U sigmah -d sigmah -c “select create_new_organization('p_organization_name', 'p_organization_logo_filename', 'p_headquarters_country_code', 'p_user_email', 'p_user_name', 'p_user_first_name', 'p_user_locale');”.

Here are the description of the parameters:

Parameter Description
p_organization_name The name of your organization
p_organization_logo_filename The filename of the logo (i.e. logo.png)
p_headquarters_country_code Use an ISO 2-letters code like “AF” from Officially assigned code elements
p_user_email Your mail address
p_user_name Your name
p_user_first_name Your first name
p_user_locale Must be “fr” or “en” or “es” don't include quotes (“)

Instead of using the psql command-line tool, you may feel more confortable using the graphical PgAdmin tool. You must first connect to the sigmah database.

Then open the “Run SQL” insterface, copy-paste the command ”select create_new_organization('p_organization_name', 'p_organization_logo_filename', 'p_headquarters_country_code', 'p_user_email', 'p_user_name', 'p_user_first_name', 'p_user_locale');“ here and run it.

Step 2 : deploy and start Sigmah

You need Tomcat 8, if you don't have it already, you can download it from the official tomcat page. Sigmah won't work in Tomcat 7.

# extract the archive
unzip apache-tomcat-8.0.30.zip

# enter the main directory
cd apache-tomcat-8.0.30

# make the script executables
chmod +x bin/*.sh

Once Tomcat 8 is installed, build the sigmah war file.

mvn clean package -Psigmah-dev

Deploy the application

mv target/sigmah-XXX.war /path/to/tomcat/webapps

Start tomcat (go back to tomcat directory)

./bin/startup.sh

You can now open your web browser and open URL

http://localhost:8080/sigmah/

If it doesn't work, have a look in the tomcat logs directory.

Once finished, stop tomcat properly:

./bin/shutdown.sh
contributorguide/preparerunningenvironment.txt · Last modified: 2016/10/12 18:10 by osarrat