Updated Sparky to add ECOMP functionality Browse, Specialized Search, BYOQ, and the...

[aai/sparky-fe.git] / README.MD

diff --git a/README.MD b/README.MD
index f4ccee5..3fd7f95 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -1,50 +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
+# Sparky - Inventory UI Service
+
+## Overview
+_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.
+
+This document covers cloning, installing, and running the front end (FE) portion of _Sparky_.
+
+## Getting Started
+
+### Building the _Sparky_ UI
+
+#### Clone the _Sparky_ FE repository
+
+Repository name is sparky-fe
+
+#### Install required tools
+
+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.
+
+Install python, v2.7.13
+
+#### Install required packages
+
+Navigate to the top level project directory and run:
+
+    > npm install
+
+#### Run or Build the Project
+
+To run the project:
+
+    > npm start
+
+By default the local instance of the UI will be served to "https://localhost:8001/aai/#/browse".
+
+This can be configured in the file "webpack.devConfig.js".
+
+To build the project (generates a .war file):
+
+    > gulp build
+    
+The build will create a directory called "dist" and add the "aai.war" file into said dist directory.
+
+If changes to the build flow are required, updating "webpack.config.js" and "gulpfile.js" will likely provide any build tuning required.
+
+## Dependencies
+
+_Sparky_ UI requires:
+
+- _Sparky_ instance that will serve the UI