docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 =============================
   4 Sparky - Inventory UI Service
   5 =============================
   6
   7 .. image:: https://bestpractices.coreinfrastructure.org/projects/1737/badge
   8    :height: 30px
   9    :width: 200 px
  10    :scale: 100 %
  11    :alt: alternate text
  12    :align: right
  13    :target: https://bestpractices.coreinfrastructure.org/projects/1737
  14
  15 Overview
  16 ========
  17 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.
  18
  19 The key AAI repos for running the Sparky UI are:
  20
  21 - aai/sparky-fe: This holds the code that constructs the GUI
  22 - aai/sparky-be: This holds the Java code and other technologies that provide the front-end with its data.
  23
  24 .. toctree::
  25    :maxdepth: 2
  26
  27    platform/index.rst