diff options
| author |   Shawn Severin <shawn.severin@amdocs.com> | 2017-11-01 16:39:25 -0400 |
|---|---|---|
| committer | Shawn Severin <shawn.severin@amdocs.com> | 2017-11-02 09:31:26 -0400 |
| commit | a557792ea855741e11223f5a1aa28aa4674dc800 (patch) | |
| tree | 6c7765f42332d469c5867d8fb4203a533a126cd8 /docs | |
| parent | d1c24a26266865b914f4bd0e899f4100426d3947 (diff) | |
Updating documentation
- Merged content of this file into Sparky back-end document
Issue-ID: AAI-255
Change-Id: I24513a1eee0ae21848d59e4a789832914f7739b5
Signed-off-by: Shawn Severin <shawn.severin@amdocs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 65 |
1 files changed, 1 insertions, 64 deletions
diff --git a/docs/index.rst b/docs/index.rst index 65db788..a5237d1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,66 +1,3 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -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 +Refer to the following document for Sparky documentation: http://onap.readthedocs.io/en/latest/submodules/aai/sparky-be.git/docs/index.html |