X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=webapp-backend%2FREADME.md;h=48c938052458bf158b0f475c7ddfc5469d31ea43;hb=c7a3ec6561b3b2ce1facbec092305977c3eba665;hp=8a142d786aadf64ec7907fc17cea0c7f60ce05ba;hpb=de17870a15d4ad8bd12828c27950aa681165413b;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/README.md b/webapp-backend/README.md index 8a142d78..48c93805 100644 --- a/webapp-backend/README.md +++ b/webapp-backend/README.md @@ -1,19 +1,13 @@ # RIC Dashboard Web Application Backend -## Launch server +The RIC Dashboard back-end provides REST services to the Dashboard +front-end Typescript features running in the user's browser. For +production use, it also serves the Angular application files. -Run `mvn -Dspring.config.name=application-abc spring-boot:run` to run a server configured -by the file 'application-abc.properties' in the local directory. +Please see the documentation in the docs/ folder. -## Development server - -Set an environment variable via JVM argument "-Dorg.oransc.ric.portal.dashboard=mock" -and run the JUnit test case DashboardServerTest for a development server to run standalone -with mock configuration and data that simulates the behavior of remote endpoints. - -## Swagger API documentation - -View the server's API documentation at URL `http://localhost:8080/swagger-ui.html`. +The backend server publishes live API documentation at the +URL `http://your-host-name-here:8080/swagger-ui.html` ## License