Wiki

Clone wiki

sts / Development

How do I get set up?

You need Java JDK version 8 or greater.

Install the Java JDK

For Ubuntu/Debian

Install from package repository:

sudo apt-get install openjdk-8-jdk

And export JAVA_HOME eg.:

export JAVA_HOME=/usr/lib/jvm/default-java

Mac OS X

Download the JDK from http://www.oracle.com/, install and export JAVA_HOME:

export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)

Windows

Download the JDK from http://www.oracle.com/, install and set the JAVA_HOME

Configuration

To configure inbound/outbound email servers and more, you need to create a configuration file (sts-config.groovy) in the root of the project (it's ignored by GIT):

#!groovy

// App Configuration
environments {

    // For Development Only
    development {


        // Grails Mail Configuration
        grails {
            mail {
                host = "my.smtp.server"
                port = 25
                username = "my-test@mail-address"
                password = "secretPassword"
                /*props = ["mail.smtp.auth":"true",
                         "mail.smtp.socketFactory.port":"465",
                         "mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory",
                         "mail.smtp.socketFactory.fallback":"false"] */
            }
        }

        // For development or debugging, force to/from to this address
        grails.mail.overrideAddress="your-own@email.address"

        // Disable all outgoing emails is also possible
        // grails.mail.disabled=true

        // STS Configuration
        sts {

            name = 'Support System'
            email = 'my-test@email.address'

            // Inbound Mail Configuration
            mail {

                inbound {
                    protocol = 'imap'
                    hostname = 'my.imap.server'
                    username = 'test@email.address'
                    password = 'secretPassword'
                }

            }
        }

    }

Running the project

Clone the repository to a local folder and execute the grailsw script (which takes care of downloading the Grails framework):

./grailsw run-app

Now access the app on http://localhost:8080/sts. The project runs in local development mode and you can quit by pressing CTRL-C. You do not have to restart the project when you are editing files, as Grails supports hot-reloading in this mode.

Producing a WAR file

./grailsw war

Produces a .war file in the target/ folder.

Updated