Merge "Adding readme file to the repo"
authorManisha Aggarwal <ma9181@att.com>
Thu, 8 Jun 2017 20:26:35 +0000 (20:26 +0000)
committerGerrit Code Review <gerrit@onap.org>
Thu, 8 Jun 2017 20:26:35 +0000 (20:26 +0000)
README.MD [new file with mode: 0644]

diff --git a/README.MD b/README.MD
new file mode 100644 (file)
index 0000000..f4ccee5
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,50 @@
+# Sparky - Inventory UI Service\r
+\r
+## Overview\r
+_Sparky_ is a service that interacts with AAI and provides users a UI to view and analyze AAI data. The main goal behind _Sparky_ is providing a more user friendly and clear view of AAI data.\r
+\r
+This document covers cloning, installing, and running the front end (FE) portion of _Sparky_.\r
+\r
+## Getting Started\r
+\r
+### Building the _Sparky_ UI\r
+\r
+#### Clone the _Sparky_ FE repository\r
+\r
+Repository name is sparky-fe\r
+\r
+#### Install required tools\r
+\r
+Install node.js, including the Node Package Manager (NPM). Installing latest should be fun, but if that is causing issues then v6.10.1 will work.\r
+\r
+Install python, v2.7.13\r
+\r
+#### Install required packages\r
+\r
+Navigate to the top level project directory and run:\r
+\r
+    > npm install\r
+\r
+#### Run or Build the Project\r
+\r
+To run the project:\r
+\r
+    > npm start\r
+\r
+By default the local instance of the UI will be served to "https://localhost:8001/aai/#/viewInspect".\r
+\r
+This can be configured in the file "webpack.devConfig.js".\r
+\r
+To build the project (generates a .war file):\r
+\r
+    > gulp build\r
+    \r
+The build will create a directory called "dist" and add the "aai.war" file into said dist directory.\r
+\r
+If changes to the build flow are required, updating "webpack.config.js" and "gulpfile.js" will likely provide any build tuning required.\r
+\r
+## Dependencies\r
+\r
+_Sparky_ UI requires:\r
+\r
+- _Sparky_ instance that will serve the UI
\ No newline at end of file

© 2017 ONAP. Copyright © The Linux Foundation ®. All Rights Reserved.
The Linux Foundation has registered trademarks and uses trademarks.
For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.
Linux is a registered trademark of Linus Torvalds.
Privacy Policy and Terms of Use