Merge "Add filters to the Jobs table of the EIC"

[portal/nonrtric-controlpanel.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 2995872..afe1a24 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,47 +1,47 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 Nordix
 
 Developer Guide
 ===============
 
-This document provides a quickstart for developers of the Non-RT RIC Controlpanel.
+This document provides a quickstart for developers of the Non-RT RIC Control Panel.
 
-The Non-RT RIC Controlpanel is an interface that allows human users to create, edit and delete policy instances, for
+The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for
 each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC.
 
 See the README.md file in the nonrtric-controlpanel repo for info about how to use it.
 
-Start the Controlpanel for development
-======================================
+Start the Control Panel for development
+=======================================
 
-To run the control panel locally for development with simulated services, follow these steps:
+To run the Control Panel locally for development with simulated services, follow these steps:
 
 - Fetch the latest code from `gerrit`_
 
-.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric-controlpanel
-
-- Start the backend:
-
-    cd webapp-backend
-
-    mvn clean install
-
-    mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlpanelTestServer -DfailIfNoTests=false test
-
-
-- Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
-
-.. _localhost:8080: localhost:8080
+.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
 
 Start the frontend:
 
     cd webapp-frontend
-
-    ./ng serve --proxy-config proxy.conf.json
-
-- Now you can open URL:  `localhost:4200`_ in a browser to access the Controlpanel.
-
-.. _localhost:4200: localhost:4200
+    
+    To start the frontend with Mock data:
+    
+    npm run start:mock
+    
+    To start the UI:
+    
+    You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
+    
+    ./ng serve --proxy-config proxy.conf.json 
+    
+    OR
+    
+    npm start
+
+- Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
+
+.. _localhost:4200: http://localhost:4200
 
 From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each
 existing policy type.