README.MD

   1 # Sparky - Inventory UI Service
   2
   3 ## Overview
   4 _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.
   5
   6 This document covers cloning, installing, and running the front end (FE) portion of _Sparky_.
   7
   8 ## Getting Started
   9
  10 ### Building the _Sparky_ UI
  11
  12 #### Clone the _Sparky_ FE repository
  13
  14 Repository name is sparky-fe
  15
  16 #### Install required tools
  17
  18 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.
  19
  20 Install python, v2.7.13
  21
  22 #### Install required packages
  23
  24 Navigate to the top level project directory and run:
  25
  26     > npm install
  27
  28 #### Run or Build the Project
  29
  30 To run the project:
  31
  32     > npm start
  33
  34 By default the local instance of the UI will be served to "https://localhost:8001/aai/#/browse".
  35
  36 This can be configured in the file "webpack.devConfig.js".
  37
  38 To build the project (generates a .war file):
  39
  40     > gulp build
  41
  42 The build will create a directory called "dist" and add the "aai.war" file into said dist directory.
  43
  44 If changes to the build flow are required, updating "webpack.config.js" and "gulpfile.js" will likely provide any build tuning required.
  45
  46 ## Dependencies
  47
  48 _Sparky_ UI requires:
  49
  50 - _Sparky_ instance that will serve the UI