Getting started

This page describes how you get started with the development of SHOGun2.

It is assumed that you know the basic concepts of this projects design and you are using a Linux-based operating system with a command line interface (CLI). Furthermore, we illustrate the usage of Eclipse with an integrated Tomcat servlet container.

Checking out the sources

At first, you have to check out the sources of SHOGun2:

Go to your (Eclipse-)workspace directory...

$ cd /your/workspace/directory

... and checkout the sources from github:

$ git clone https://github.com/terrestris/shogun2.git

A new folder shogun2 should have been created. Enter this directory:

$ cd shogun2

Building with maven

Execute

$ mvn clean install

to install all SHOGun2-artifacts to your local maven repository.

Using Eclipse with integrated Tomcat

Execute

$ mvn eclipse:clean eclipse:eclipse

to create Eclipse-.project files (and more).

If you open Eclipse now, you can go to File -> Import -> Existing Projects into Workspace and select the shogun2 root-directory (the one you've just checked out from github above).

You now should see some projects (one for each with packaging jar) that you can import by clicking on Finish import.

In case of a successful import, dependent projects/modules should reference each other, which is very nice, because changes in Module X will immediately be available in any module that depends on Module X. For example, you could check, if the DAO-Project references the Model-project by right-clicking on the DAO-project -> Properties -> Java Build Path. In the Projects-Tab you should see an entry for the shogun2-model-project.

This page will soon be filled with informations on how to use the shogun2-webapp-archetype in combination with Tomcat/Eclipse.