Show Navigation

Questions

Is Grails an Open Source project?

Yes, Grails is an Open Source project licensed under the Apache License v2. You can see the license header in all the source files, as well as a license file at the root of the project

What is the best way to learn about Grails?

Read the User Guide for the version you are planning to use. We recommend you start with the latest stable version of the framework. We have also written a collection of Guides, which contain step-by-step tutorials for solving common scenarios.

Do you offer Grails training?

OCI, sponsor of Grails' development, offers Grails and GORM courses developed and delivered by Grails co-founders and the core engineering team.

Where can I ask questions about usage?

The best place to get community support is Stack Overflow or Slack- Login or Join Grails Community Slack.

Where can I find Grails on social media?

You can find Grails on Twitter and LinkedIn.

Do you have a mailing list?

Yes. Subscribe to our Google Group here.

Where can I suggest a new feature or share an interesting finding?

The Grails mailing list is a great place to start a conversation with the Grails developers and other Grails users.

What's the difference between the mailing list and interaction on Stack Overflow?

Use the mailing list for discussion around the framework's development. For questions we recommend Stack Overflow

How do I report an issue with the Grails framework?

The Grails project uses Github issues to report and track issues, feature enhancements, and new features. Make sure you're logged-in before proceeding. Report an issue.

How can I contribute to improving the documentation?

Grails documentation comes in several forms:

  • the reference documentation contains language specification, user guides, a getting started tutorial, and more.
  • the GroovyDoc APIs documents the classes of the Grails code base
  • GitHub allows users to contribute to this website.

Contributing to the Grails.org website is fairly easy. Create a GitHub account or sign in with an existing account, then open Grails.org and select the "Improve this doc" button at the top of the page you wish to edit. Please don't hesitate to help us make improvements, fix typos or broken language, clarify complicated sections, add new material, and anything else you feel will be helpful to other Grails users.

How can I contribute to Grails code?

If you are looking to make an initial contribution, just raise your hand on the Grails developer mailing-list and tell us about your desire to work on a particular problem.

For more complicated tasks, the best approach is to bring your interest to the attention of the Grails developers. They can provide guidance on how best to tackle a particular problem, collaborate on implementation ideas, and discuss the semantics or scope of the proposed change.

Cloning the code base

To work on the Grails code base, you should be proficient in Git and (ideally) have an account on GitHub, so you can create pull requests with your changes.

If you have Git installed on your machine, you should be able to clone the Grails repository with the following command:

git clone git://github.com/grails/grails-core.git

Make sure you configure Git appropriately with the same email that you registered with on GitHub.

git config --global user.name "YOUR NAME"
git config --global user.email "YOUR EMAIL"</code></pre>

You can verify these are configured appropriately by running:

git config --list

Working on the code base

If you are working with the IntelliJ IDEA development environment, you can import the project using the Intellij Gradle Tooling ( "File / Import Project" and select the "build.gradle" file).

To get a local development version of Grails working, first run the install task.

./gradlew install

Then install SDKman, which is the quickest way to set up a development environment.

Once you have SDKman installed, point SDKman to your local development version of Grails.

sdk install grails dev /path/to/checkout
sdk use grails dev

Now the "grails" command will be using your development version!

The most important command you will have to run before sending your changes is the test command.

./gradlew test

For a successful contribution, all tests should be green!

Creating a pull request

Once you are satisfied with your changes:

  • commit your changes in your local branch
  • push your changes to your remote branch on GitHub
  • send us a pull request

Where can I view the build status?

Grails sources are tested using our continuous integration server.

Who sponsors Grails development?

The Grails project is generously sponsored by several companies:

  • OCI maintains the Grails framework and employs key members of the Grails team.
  • Pivotal provides website hosting for Grails.org.
  • JFrog provides the infrastructure for deploying and hosting our snapshots and releases, thanks to the Bintray social platform for distribution and the OSS Artifactory repository.
  • YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.