X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=webapp-backend%2FREADME.md;h=48c938052458bf158b0f475c7ddfc5469d31ea43;hb=56ff26b25a114f55b66e47d8f2430d8fb8e3cda3;hp=04da1a9124dfa038419432925afa14ca8a852f52;hpb=bda70e88ca63203c5a8cc034e824ec5855c32e4b;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/README.md b/webapp-backend/README.md index 04da1a91..48c93805 100644 --- a/webapp-backend/README.md +++ b/webapp-backend/README.md @@ -1,8 +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. + +The backend server publishes live API documentation at the +URL `http://your-host-name-here:8080/swagger-ui.html` ## License