Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/matrei/pingcrm-grails

Grails/Groovy version of the Inertia.js demo application Ping CRM
https://github.com/matrei/pingcrm-grails

Last synced: about 2 months ago
JSON representation

Grails/Groovy version of the Inertia.js demo application Ping CRM

Awesome Lists containing this project

README

        

# Ping CRM on Grails
[![Java CI](https://github.com/matrei/pingcrm-grails/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/matrei/pingcrm-grails/actions/workflows/gradle.yml)

A demo application built with **[Grails](https://grails.org)** and **[Vue.js](https://vuejs.org)** to illustrate how **[Inertia.js](https://inertiajs.com/)** works.\
It uses the [Grails Adapter for Inertia.js](https://github.com/matrei/grails-inertia-plugin) plugin.
>[!NOTE]
>This is a port to Grails/Groovy of the [original Ping CRM](https://github.com/inertiajs/pingcrm) written in Laravel/PHP.

![Screenshot of the Ping CRM application](screenshot.png)

>[!NOTE]
> There is a live demo of this application at:
> **https://pingcrm.mattiasreichel.com**
>
> The demo is running in a container that is destroyed/recreated at the top of every hour.\
>**Please be respectful when editing data!**

## Requirements
- Java 17+
- Npm

## Installation
Clone the repo locally
```shell
git clone https://github.com/matrei/pingcrm-grails.git
cd pingcrm-grails
```
\
Install client dependencies
```shell
npm install
```
## Running
### In development mode ...
Serve client files with [hot module replacement](https://vitejs.dev/guide/features.html#hot-module-replacement)
```shell
npm run serve
```
\
and start the grails application
```shell
./gradlew bootRun
```

### ... or in production mode
with bundled/minified client files
```shell
./gradlew -Dgrails.env=production bootRun
```

### You're ready to go!
Visit Ping CRM in your browser - http://localhost:8080

## Running tests
To run the Ping CRM test suite, run:
```shell
./gradlew check
```

## Build for production
To create a runnable war for production (in `~/pingcrm-grails/build/libs`)
```shell
./gradlew assemble
```
that can be run with:
```shell
java -jar build/libs/pingcrm-grails-3.3.3-SNAPSHOT.war
```

## SSR
To run the application in server-side rendering mode, you need node >= v18 installed on your system.
SSR is disabled by default. To enable it, set the `inertia.ssr.enabled` config property to `true` in `application.yml`.
The default location of the SSR bundle is `src/main/resources/ssr/ssr.mjs`.
You can change it by setting/adding the `inertia.ssr.bundle` config property.

## Credits
* Port to Grails by Mattias Reichel (@mattias_reichel)
* Original work by Jonathan Reinink (@reinink) and contributors