From: Arul.Nambi <arul.nambi@amdocs.com>
Date: Mon, 16 Oct 2017 15:33:17 +0000 (-0400)
Subject: Updating the documents
X-Git-Tag: v1.0.0~2
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fsparky-fe.git;a=commitdiff_plain;h=d1c24a26266865b914f4bd0e899f4100426d3947

Updating the documents

Issue-id: AAI-438
Change-Id: I04d3176ac0665705939bed03b7d2e59e53a5e13a
Signed-off-by: Arul.Nambi <arul.nambi@amdocs.com>
---

diff --git a/docs/index.rst b/docs/index.rst
index 833e1aa..65db788 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,66 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-TODO Add files to toctree and delete this header
-------------------------------------------------
-.. toctree::
-   :maxdepth: 1
+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 _Sparky_
+------------------
+
+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/#/viewInspect".
+
+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
\ No newline at end of file