8a142d786aadf64ec7907fc17cea0c7f60ce05ba
[portal/ric-dashboard.git] / webapp-backend / README.md
1 # RIC Dashboard Web Application Backend
2
3 ## Launch server
4
5 Run `mvn -Dspring.config.name=application-abc spring-boot:run` to run a server configured
6 by the file 'application-abc.properties' in the local directory.
7
8 ## Development server
9
10 Set an environment variable via JVM argument "-Dorg.oransc.ric.portal.dashboard=mock"
11 and run the JUnit test case DashboardServerTest for a development server to run standalone
12 with mock configuration and data that simulates the behavior of remote endpoints.
13
14 ## Swagger API documentation
15
16 View the server's API documentation at URL `http://localhost:8080/swagger-ui.html`.
17
18 ## License
19
20 Copyright (C) 2019 AT&T Intellectual Property & Nokia. All rights reserved.
21 Licensed under the Apache License, Version 2.0 (the "License");
22 you may not use this file except in compliance with the License.
23 You may obtain a copy of the License at
24
25      http://www.apache.org/licenses/LICENSE-2.0
26
27 Unless required by applicable law or agreed to in writing, software
28 distributed under the License is distributed on an "AS IS" BASIS,
29 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30 See the License for the specific language governing permissions and
31 limitations under the License.