diff options
author | 2020-05-04 16:29:48 +0200 | |
---|---|---|
committer | 2020-05-06 12:47:37 +0000 | |
commit | 91144c56729477da29515e88d5cea787c9bc9614 (patch) | |
tree | 11d3614a8cb86e55ba89b19c2cc62e6355f7a583 /README.md | |
parent | d4e51cbc3f4925993a91798ef172f10686cf1b72 (diff) |
adding the basic running steps for CDS in README file
Issue-ID: CCSDK-2357
Signed-off-by: AhmedEldeeb50 <ahmed.eldeeb.ext@orange.com>
Change-Id: I67d389820bffcac56ee27936f7bf33eec059a94f
(cherry picked from commit 5b9f323027c74d11aa0af8061c77118c8ff81a74)
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
@@ -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 |