Grails

Getting help

Join the discussions on Slack
Ask questions on Stack Overflow

What is Grails?

Grails is a framework used to build web applications with the Groovy programming language. The core framework is very extensible and there are numerous plugins available that provide easy integration of add-on features.

Commercial support options are available.

Getting Started

You need a Java Development Kit (JDK) installed, but it is not necessary to install Groovy because it's bundled with the Grails distribution.

It's recommended to use the SDKMAN! tool to install & manage multiple Grails version. Alternatively, visit https://grails.org/download.html for other install options. If downloading the binary, the only requirement is it be added to your path.

To create your first Grails Application, you can use Grails Forge or you can use the command line. For legacy reasons, there exists 2 ways to generate Grails applications. Grails Forge and Grails Shell. The grails binary allows you to use either to generate an app.

For example purposes, using the legacy shell:

grails create-app sampleapp
cd sampleapp
./gradlew bootRun

To build Grails, clone this GitHub repository and execute the build Gradle target:

git clone https://github.com/apache/grails-core.git
cd grails-core
./gradlew build -PskipTests

If you encounter out of memory errors when trying to run the build, try adjusting Gradle build settings. For example:

export GRADLE_OPTS="-Xmx2G -Xms2G -XX:NewSize=512m -XX:MaxNewSize=512m"

Please note that a valid container runtime is required to run Grails Tests. The example above omits the tests so the build will pass.

Performing a Release

See RELEASE.md.

Friends of Apache Grails Open Collective

As an independent initiative, community members have set up an open collective for Apache Grails:

https://opencollective.com/friends-of-grails

This initiative is designed to complement the Apache project and the many contributions we get from our great community and supporters.

License

Grails and Groovy are licensed under the terms of the Apache License, Version 2.0.

---

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.