X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=6820fd6347666def0780896f13f85fc6df8fade7;hb=179faedca5831f95ca223644d263bd34ff163cc9;hp=459360eb3faf73fc6dcd2bd560470dd7ec509ac3;hpb=448fac1c4e8444418f9674585ecf958bc6c98df5;p=portal%2Fric-dashboard.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 459360eb..6820fd63 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,25 +1,11 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 AT&T Intellectual Property and Nokia -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 RIC Dashboard Developer Guide ============================= -This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web application. +This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web +application. Prerequisites ------------- @@ -27,7 +13,20 @@ Prerequisites 1. Java development kit (JDK), version 11 or later 2. Maven dependency-management tool, version 3.4 or later -Other tools including the Node Package Manager (npm) are fetched dynamically. +Other required tools including the Node Package Manager (npm) are fetched dynamically. + +Clone and Update Submodules +--------------------------- + +After cloning the repository, initialize and update all git submodules like this:: + + git submodule init + git submodule update + +Check the submodule status at any time like this:: + + git submodule status + Angular Front-End Application ----------------------------- @@ -82,7 +81,8 @@ Production user authentication The server uses the ONAP Portal's "EPSDK-FW" library to support a single-sign-on (SSO) feature, which requires users to authenticate -at the ONAP Portal UI. +at the ONAP Portal UI. The RIC Dashboard can be on-boarded as an +application on the ONAP Portal using its application on-boarding UI. The server authenticates requests using cookies that are set by the ONAP Portal::