Use O-RAN-SC
[portal/ric-dashboard.git] / README.md
1 # O-RAN-SC RIC Dashboard Web Application
2
3 This webapp is built with Angular 7 and Spring-Boot 2.
4
5 ## Getting started
6
7 To install prerequisites on Mac OSX, first install nvm then continue with node:
8
9         curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
10
11 Then:
12
13         nvm install stable
14         nvm install node
15
16 To run the web app:
17
18     cd ric-dashboard/ang7-sb2
19     mvn clean install
20
21     cd ric-dashboard/ang7-sb2/backend/
22     mvn spring-boot:run
23
24 To debug the frontend and backend for Angular developers:
25
26     cd ric-dashboard/ang7-sb2/frontend/src/main/web/src/app
27     ./ng serve --proxy-config proxy.conf.json
28
29 ## License
30
31 Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.
32 Licensed under the Apache License, Version 2.0 (the "License");
33 you may not use this file except in compliance with the License.
34 You may obtain a copy of the License at
35
36      http://www.apache.org/licenses/LICENSE-2.0
37
38 Unless required by applicable law or agreed to in writing, software
39 distributed under the License is distributed on an "AS IS" BASIS,
40 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
41 See the License for the specific language governing permissions and
42 limitations under the License.