Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaelcurrin/grails-quickstart

A simple auto-generated Grails app
https://github.com/michaelcurrin/grails-quickstart

gradle grails groovy java quickstart

Last synced: about 11 hours ago
JSON representation

A simple auto-generated Grails app

Awesome Lists containing this project

README

        

# Grails Quickstart
> A simple auto-generated Grails app

## Sample

![sample](sample.png)

## Purpose

This project is a simple Grails-based web-app - it includes dependency management, tests, a deploy pipeline and HTML.

There is a _lot_ of boilerplate here generated by the quickstart. I didn't change any code from the auto-generated quickstarted - I just added docs.

This doesn't do much so just serves as a reference for myself on how a Grails app is setup.

## How to create a Grails app

The Grails Application Forge service creates a quickstart/scaffold and that was used for this project.

- http://start.grails.org/

The service lets you download a zip file with the Generate button or a curl command (using your app name). The default settings were used - a web app, though you can choose React, REST API, etc. The latest Grails version was used.

```sh
$ curl -O start.grails.org/grailsQuickstart.zip -d version=4.0.3
```

The app was nammed `grailsQuickstart` so the name `grailsquickstart` now appears in part of the code.

For a more detailed guide, see [Creating your first Grails app](https://guides.grails.org/creating-your-first-grails-app/guide/index.html) in the Grails docs.

## Requirements

- [Java](https://java.com)
- [Groovy](https://groovy-lang.org)
- [Grails](https://grails.org)

## Installation

### System dependencies

Install Grails.

Recommended - install using _SDKMAN!_ approach and then Grails through the `sdk` command. See the Grails [Download](https://grails.org/download.html) page for full details.

Check it installed globally.

```sh
$ grails -version
```

## Usage

### Run application

Run Grails in the project root - this will resolve dependencies and configure the application.

```sh
$ grails
```

Type `run-app` and press Return

Open in the browser:

- http://localhost:8080

### Run tests

```sh
$ bash gradlew clean check
```

Sample output:

```
BUILD SUCCESSFUL in 7s
8 actionable tasks: 7 executed, 1 up-to-date
```