This is a sample project using Grails 3, Spock, and Spring REST docs. For more information about the Grails framework please see grails.org.
Grails is built on top of Spring Boot and Gradle so there are a few different ways to run this project including:
Gradle Wrapper (recommended)
The gradle wrapper allows a project to build without having Gradle installed locally. The executable file will acquire the version of Gradle and other dependencies recommended for this project. This is especially important since some versions of Gradle may cause conflicts with this project.
On Unix-like platforms, such as Linux and Mac OS X:
$ ./gradlew run
$ gradlew run
Please note, if you are including integration tests in Grails, they will not run as
part of the
gradle test task. Run them via the build task or individually as
Gradle Command Line
Clean the project:
$ gradle clean
Build the project:
$ gradle build
Run the project:
$ gradle run
Grails Command Line
Grails applications also have a command line feature useful for code generation and
running projects locally. The command line is accessible by typing
grails in the
terminal at the root of the project. Please ensure you are running the correct version
of Grails as specified in gradle.properties
gradle clean, this task destroys the
build directory and cached assets.
The 'test-app' task runs all of the tests for the project.
run-app task is used to run the application locally. By default, the project is
run in development mode including automatic reloading and not caching static assets. It
is not suggested to use this in production.
Building and Viewing the Docs
This is an example of the Grails API profile. Therefore, there is no view layer to
return the docs as static assets. The result of running
build is that
the docs are sent to
/build/asciidoc/. You can then publish them to a destination of
your choosing using the gradle github-pages
plugin or similar.
To just generate documentation and not run the application use:
$ ./gradlew asciidoctor