summaryrefslogtreecommitdiffstats
path: root/README.MD
diff options
context:
space:
mode:
Diffstat (limited to 'README.MD')
-rw-r--r--README.MD22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..7e1043b
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,22 @@
+# Validation microservice
+
+This project has mixed Java and Groovy source code.
+
+[Maven](https://maven.apache.org/) 3+ is required.
+
+#### To build and run tests:
+`mvn clean verify`
+
+Eclipse users should install [Groovy Eclipse plugins](https://github.com/groovy/groovy-eclipse/wiki).
+
+#### To generate jars (including apidocs):
+`mvn package`
+
+#### To run on localhost:
+`mvn spring-boot:run`
+
+### HTTPS interfaces
+
+[Validation Service](https://localhost:9501/services/validation-service/v1/app/validate)
+
+[Info Service](https://localhost:9501/services/validation-service/v1/core/core-service/info)