docs/index.rst

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