X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=webapp-backend%2FREADME.md;h=48c938052458bf158b0f475c7ddfc5469d31ea43;hb=bf91f764c67001c4cad28075a38fd9196744c041;hp=2909dede11dbe7a396bed9948e56c1245e8f29a4;hpb=1379dce23d47c42d169ed13a337bbee827714830;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/README.md b/webapp-backend/README.md index 2909dede..48c93805 100644 --- a/webapp-backend/README.md +++ b/webapp-backend/README.md @@ -1,12 +1,13 @@ # RIC Dashboard Web Application Backend -## Development 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.profiles.active=mock spring-boot:run` for a dev server. Navigate to `http://localhost:8080/swagger-ui.html`. +Please see the documentation in the docs/ folder. -## Alternate configuration - -Run `mvn -Dspring.config.name=application-abc spring-boot:run` to read configuration from the file 'application-abc.properties' in the local directory. +The backend server publishes live API documentation at the +URL `http://your-host-name-here:8080/swagger-ui.html` ## License