Update getting-started instructions and paths
[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 ### Check prerequisites
8
9 1. Java development kit (JDK), version 1.8 or later
10 2. Maven dependency-management tool, version 3.4 or later
11   
12 ### Build and launch the web app
13
14     mvn -Ddocker.skip=true clean install
15     cd webapp-backend
16     mvn spring-boot:run
17
18 Then open a browser on http://localhost:8080
19
20 In addition to the above, you can run the Angular server 
21 for debugging the frontend and backend separately:
22
23     cd webapp-frontend
24     ./ng serve --proxy-config proxy.conf.json
25
26 Then open a browser on http://localhost:4200
27
28 ## License
29
30 Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.
31 Licensed under the Apache License, Version 2.0 (the "License");
32 you may not use this file except in compliance with the License.
33 You may obtain a copy of the License at
34
35      http://www.apache.org/licenses/LICENSE-2.0
36
37 Unless required by applicable law or agreed to in writing, software
38 distributed under the License is distributed on an "AS IS" BASIS,
39 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
40 See the License for the specific language governing permissions and
41 limitations under the License.