Merge "adding the basic running steps for CDS in README file"

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
index 5c7ef103a..ba9c29357 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,46 @@
 
 ## Reference
 https://github.com/pinterest/ktlint
+
+## Getting started
+
+![Basic_Architecture](./docs/media/CDS.png)
+
+## Basic Requirements
+Before you can build this project, you must install and configure the following dependencies on your machine:
+
+  1- Java 8 SDK
+  
+  2- Node and npm installed
+  
+  3- Angular CLI & Angular v8
+  
+  4- MySQL Database
+  
+  5- maven
+  
+## Running in Development Mode
+
+* In the main project folder run `mvn clean install` command to install all libraries and dependencies for maven and npm.
+
+ 1- Back-end MS
+  
+  * create `sdnctl` table in MySQL 
+  * (Optional) You could run the project in a specific profile(dev, local) by adding `-Dspring.profiles.active=profile-name`
+  
+2- Loop-back server: that allow your request to reach the backend from cds-ui
+ * move to `./cds-ui/server/` folder and run the  command `npm start`
+ 
+ 3- cds-ui
+ 
+ * move to `./cds-ui/designer-client/` folder and run the command `npm start`, This command will make sure all the files follow the linting rules and then connect to the loopback server.
+
+## Using an IDE
+
+**Front-end** you could use `vscode` or `webstorm`.
+ 
+**Back-end** `Intellij` with kotlin plugin or any other editor
+
+
+---
+For more information check the `docs` folder.
\ No newline at end of file