From d182202fc6001983541504ed323d68479086317e Mon Sep 17 00:00:00 2001
From: WuKong <rebirthmonkey@gmail.com>
Date: Sat, 22 Apr 2017 13:25:07 +0200
Subject: add moonv4

Change-Id: I247af788d0b0fb961fbc85416486b241eb1d807c
Signed-off-by: WuKong <rebirthmonkey@gmail.com>
---
 moonv4/moon_gui/readme.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 moonv4/moon_gui/readme.md

(limited to 'moonv4/moon_gui/readme.md')

diff --git a/moonv4/moon_gui/readme.md b/moonv4/moon_gui/readme.md
new file mode 100644
index 00000000..3e7215b2
--- /dev/null
+++ b/moonv4/moon_gui/readme.md
@@ -0,0 +1,60 @@
+
+GUI for the Moon project
+================================
+
+This directory contains all the code for the Moon project
+It is designed to provide a running GUI of the Moon platform instance.
+
+
+## Usage
+
+### Prerequist
+-   `sudo apt-get install nodejs nodejs-legacy`
+-   `sudo npm install --global gulp-cli`
+
+### Install all packages 
+-   `cd  $MOON_HOME/moon_gui`
+-   `sudo npm install`
+
+### Run the GUI
+-   `gulp webServerDelivery`
+- Open your web browser
+
+
+## Configuration
+
+### Build the delivery package
+-   `gulp delivery`
+-   `gulp webServerDelivery`
+
+### Development
+
+During the development it is possible to use the following commands : 
+-   `gulp build`
+-   `gulp webServer`
+- Gulp webServer will refresh the browse when a file related to the application is changed
+  
+
+### Constants
+It is possible to change some constants (API endpoints)
+-   `cd  $MOON_HOME/moon_gui/static/app/moon.constants.js`
+
+
+### CORS
+
+The GUI need to connect itself to Keystone and Moon.
+Opening CORS into them to the GUI Web Server is required.
+
+In order to modify Keystone :
+
+`cd  $pathtoVmSpace/docker/keystone`
+
+Concerned file is run.sh 
+
+In order to modify Moon :
+
+`cd  $MOON_HOME/moon_interface/interface`
+
+Concerned file is http_server.py
+ 
+ 
-- 
cgit 1.2.3-korg