# ginkgo

**Repository Path**: jtx/ginkgo

## Basic Information

- **Project Name**: ginkgo
- **Description**: Base Apereo CAS Maven WAR Overlay template.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-05-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#ginkgo
This project *ginkgo* has been created to test the CAS server and the CAS services management webapps (version >= *4.2*) using the *Maven overlay* mechanism: [http://apereo.github.io/cas/4.0.x/installation/Maven-Overlay-Installation.html](http://apereo.github.io/cas/4.0.x/installation/Maven-Overlay-Installation.html).  
It's composed of two overlays:

- the *ginkgo-cas* module is the CAS server webapp
- the *ginkgo-cas-management* module is the CAS services management webapp.

## Get started

### Prerequisite
1. JDK 1.8  or higher
2. Maven 3 or higher

### Maven build
At the project root folder:

- To build and run the tests, run `mvn clean package`.


### Maven deploy
Under 'ginkgo-cas' folder:

- To deployment in Jetty, run `mvn jetty:run`. 

## Development setup
Install [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) and set environmental variable `JAVA_HOME` to the path to your JDK installation. Install [Maven](https://maven.apache.org/) if you want to use Maven at command line. 

### Key development tools
The following tools should be used for development: 

- [Eclipse IDE](https://eclipse.org) for Java Developers, MARS or newer.

### Git configuration
One-time Git configuration (can be done either in command line or through Eclipse preferences):

- `git config --global user.name "<your-name>"`
- `git config --global user.email <your-email>`
- `git config --global branch.autosetuprebase always`