summaryrefslogtreecommitdiffstats
path: root/README.MD
diff options
context:
space:
mode:
authorPrudence Au <prudence.au@amdocs.com>2018-08-13 17:06:59 -0400
committerPierre Rioux <pierre.rioux@amdocs.com>2018-08-21 11:21:26 -0400
commitc604f64b971491f8c9b953adce54b847d7946e26 (patch)
tree134f7fc91b4da9e04c564c92337d44df420c8df0 /README.MD
parent3baa3ebd0000b15f1c54c736f4a307731b16b923 (diff)
Initial submission for validation service
Change-Id: I9372430f1ae347373d5a9a0c7a427d7bd393d61e Issue-ID: LOG-427 Signed-off-by: Prudence Au (prudence.au@amdocs.com) Signed-off-by: Geora Barsky <georab@amdocs.com> Signed-off-by: Pierre Rioux <pierre.rioux@amdocs.com>
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)