docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. _master_index:
   3
   4 =============================
   5 Sparky - Inventory UI Service
   6 =============================
   7
   8 .. image:: https://bestpractices.coreinfrastructure.org/projects/1737/badge
   9    :height: 30px
  10    :width: 200 px
  11    :scale: 100 %
  12    :alt: alternate text
  13    :align: right
  14    :target: https://bestpractices.coreinfrastructure.org/projects/1737
  15
  16 Overview
  17 ========
  18 Sparky is a service that interacts with resources and traversal microservices, and provides users with a user interface to view and analyze AAI data. The main goal behind Sparky is to provide a clear and user friendly view of AAI data.
  19
  20 The key AAI repos for running the Sparky UI are:
  21
  22 - aai/sparky-fe: This holds the code that constructs the GUI
  23 - aai/sparky-be: This holds the Java code and other technologies that provide the front-end with its data.
  24
  25 .. toctree::
  26    :maxdepth: 2
  27
  28    platform/index.rst