search

GreenButtonAlliance / OpenESPI-Common-java

Common library for Green Button Third Party and Data Custodian OpenESPI Applications
Apache License 2.0
29 stars 61 forks source link
data-custodian java openespi pivotal spring third-party

readme

CircleCI Quality Gate Status

OpenESPI-Common -- Archived January 29, 2024

NOTE: This repository is no longer maintained. The OpenESPI project has been archived and is no longer being maintained.

This is the Common module of the OpenESPI Green Button Data Custodian and Third Party implementation. It is a Spring application written in java and built on top of jpa for database access.

This Common run-time and test code is shared between stand-alone Data Custodian and Third Party applications. OpenESPI-DataCustodian and OpenESPI-ThirdParty.

An operational sandbox with these services operating may be found at: sandbox.greenbuttonalliance.org:8443

Setup

First clone the project from github:

git clone https://github.com/greenbuttonalliance/OpenESPI-Common-java.git
cd OpenESPI-Common

Then install the OpenESPI-Common JAR in your local repository:

# The JUnit test have not been maintained since the original creation of the repository. 
# Any errors encountered here are due to not including the "-Dmaven.test.skip=true" portion of the command.
mvn -Dmaven.test.skip=true clean install

# or for a specific profile
mvn -P <profile name> -Dmaven.test.skip=true clean install

IDE Setup

Eclipse Setup

Open Eclipse and import a Maven project (File > Import... > Maven > Existing Maven Projects).

Spring Tool Suite Setup

Open Spring Tool Suite and import a Maven project (File > Import... > Maven > Existing Maven Projects).

IntelliJ Setup

Open IntelliJ and open the project (File > Open...).

Testing

All testing of OpenESPI is performed using the Test Harness project. See the README file for instructions.