- ![Stories in Progress](https://badge.waffle.io/grails/grails-core.png?label=in progress&title=In Progress)
[Grails][Grails] is a framework used to build web applications with the [Groovy][Groovy] programming language. The core framework is very extensible and there are numerous [plugins][plugins] available that provide easy integration of add-on features. [Grails]: http://grails.org/ [Groovy]: http://groovy-lang.org/ [plugins]: http://grails.org/plugins/
Grails is sponsored by Object Computing Inc. in St. Louis Missouri. Please contact info@ociweb.com for support inquiries.
You need a Java Development Kit (JDK) installed, but it is not necessary to install Groovy because it's bundled with the Grails distribution.
To install Grails, visit http://grails.org/Download and download the version you would like to use. Set a GRAILS_HOME
environment variable to point to the root of the extracted download and add GRAILS_HOME/bin
to your executable PATH
. Then in a shell, type the following:
grails create-app sampleapp
cd sampleapp
grails run-app
To build Grails, clone this GitHub repository and execute the install Gradle target:
git clone https://github.com/grails/grails-core.git
cd grails-core
./gradlew install
If you encounter out of memory errors when trying to run the install target, try adjusting Gradle build settings. For example:
export GRADLE_OPTS="-Xmx2G -Xms2G -XX:NewSize=512m -XX:MaxNewSize=512m -XX:MaxPermSize=1G"
Releases of Grails are automated by Travis CI.
To create a release perform the following steps.
First check that the tests are passing and all is well on Travis.
Next, update the Grails version in build.gradle
and grails-core/src/test/groovy/grails/util/GrailsUtilTests.java
and then push the changes to git:
$ git add build.gradle grails-core/src/test/groovy/grails/util/GrailsUtilTests.java
$ git commit -m "Release Grails 3.0.1"
$ git tag v3.0.1
$ git push --tags
$ git push
After pushing these changes to the repository you must wait for the build to complete. During this phase the JAR files will be uploaded to the Grails Artefactory Repository.
The Travis CI build will automatically upload the tagged release to Github and be available of the Releases page.
Note: Although by default Grails uses Artefactory to resolve dependencies, it is useful to have them in Maven Central too. To ensure they go to Maven Central login to Sonatype OSS Nexus with your account details then "Close" and "Release" the staged JAR files.
Grails and Groovy are licensed under the terms of the [Apache License, Version 2.0][Apache License, Version 2.0]. [Apache License, Version 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html
YourKit is kindly supporting Grails open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products: YourKit Java Profiler and YourKit .NET Profiler.