aboutsummaryrefslogtreecommitdiffstats
path: root/dashboard/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dashboard/README.md')
-rw-r--r--dashboard/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/dashboard/README.md b/dashboard/README.md
new file mode 100644
index 00000000..f4c095eb
--- /dev/null
+++ b/dashboard/README.md
@@ -0,0 +1,35 @@
+# Moon Dashboard
+
+To build project, yarn is necessary : https://yarnpkg.com/
+
+This project uses Vuejs framework : https://vuejs.org/
+
+This project uses Orange Boosted for styles : https://boosted.orange.com/
+
+
+## Project setup
+```
+yarn install
+```
+Install all dependencies.
+
+### Compiles and hot-reloads for development
+```
+yarn run serve
+```
+Follow instruction in console to test this project in development mode.
+
+### Compiles and minifies for production
+```
+yarn run build
+```
+All generated files are in dist folder, this folder can be copied to be served directly by server.
+
+
+### Configuration
+Configuration are in src/config.js file.
+Define Moon Manager server URL.
+
+
+### TODO
+- test of services (see ../www/moon/services/*.spec.js for the old versions)