summaryrefslogtreecommitdiffstats
path: root/gui-clamp/README.md
diff options
context:
space:
mode:
authorLiam Fallon <liam.fallon@est.tech>2021-11-05 15:58:38 +0000
committerGerrit Code Review <gerrit@onap.org>2021-11-05 15:58:38 +0000
commitac5aa9c10654c336a85e81d6784b088f98e5c67b (patch)
treec1240c4d526a6a18cbb912fecc38764314d910bc /gui-clamp/README.md
parentbfda0ad41502165f52e772e74bd3d499f010bc18 (diff)
parent1d81823510e9cb13657615b835c8454b65865af1 (diff)
Merge "Added package-lock.json to the gui-clamp"
Diffstat (limited to 'gui-clamp/README.md')
-rw-r--r--gui-clamp/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/gui-clamp/README.md b/gui-clamp/README.md
new file mode 100644
index 0000000..cbb6908
--- /dev/null
+++ b/gui-clamp/README.md
@@ -0,0 +1,37 @@
+# Summary
+
+Copyright (C) 2021 Nordix Foundation.
+This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+
+This source repository contains the ONAP Policy GUI code.
+
+
+The gui-clamp repo can be built with maven commands but it can also be build,run,test with npm commands.
+
+Prerequsite:
+The following tools should be installed to run this project,
+
+```
+Package Version
+node 14.18.1
+npm 8.1.2
+```
+
+Build & Run:<br>
+To install the npm packages,
+```
+npm install --legacy-peer-deps
+```
+To run test,
+```
+npm run test
+[OR]
+npm test -- -u
+```
+```
+npm run build
+```
+```
+npm start
+``` \ No newline at end of file