From: subhash kumar singh <subh.singh@samsung.com>
Date: Thu, 18 May 2023 16:55:01 +0000 (+0000)
Subject: Documentation to build dev env
X-Git-Tag: 2.1.0~9
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=ca7c0d32914a709a8dc5aea5094f6a6021c815f1;p=ric-plt%2Fricdms.git

Documentation to build dev env

Added documentation to setup development environment.

Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
Change-Id: I55975d80a9a4ff5e618598da16b1d3822818aec4
---

diff --git a/README.md b/README.md
index fd717cf..13bc197 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
 # RICDMS
 
+- [RICDMS](#ricdms)
+  - [Building](#building)
+    - [Local build and Run](#local-build-and-run)
+    - [Kubernetes](#kubernetes)
+  - [Developer Environment](#developer-environment)
+    - [Mocking all the dependent services (chartmuseum, appmgr...)](#mocking-all-the-dependent-services-chartmuseum-appmgr)
+    - [Running the RICDMS](#running-the-ricdms)
+
 
 ## Building
 
@@ -79,3 +87,20 @@ NAME                         DATA   AGE
 configmap/kube-env           1      90s
 ```
 
+## Developer Environment
+
+### Mocking all the dependent services (chartmuseum, appmgr...)
+One can bring [`moco`](https://github.com/dreamhead/moco) server to mock environment for development purpose. Mocks are captured in `mock` folder.
+
+Use below command to bring up the mock server :
+```sh
+$ docker run --rm -d -v /home/ubuntu/osc/ric-plt/ricdms/mock:/var/moco -p 9191:8000 rezzza/docker-moco:latest
+```
+
+### Running the RICDMS
+Export the `` enviroment variable to use the URLs from `` so that mock server could be used.
+```bash
+$ export RIC_DMS_CONFIG_FILE=$(pwd)/config/config-test.yaml
+```
+
+Now, developer environment is ready :computer:
\ No newline at end of file