Initial import into ODL
[dlux.git] / README.md
1 opendaylight-ui
2 ===============
3
4 OpenDaylight SDN Controller - UI (AngularJS 100% Client Side)
5
6 Setting it up
7 ------------
8     # curl https://raw.github.com/creationix/nvm/master/install.sh | sh
9
10     ...
11
12     Cloning into '/root/.nvm'...
13     remote: Counting objects: 602, done.
14     remote: Compressing objects: 100% (396/396), done.
15     remote: Total 602 (delta 296), reused 484 (delta 195)
16     Receiving objects: 100% (602/602), 91.40 KiB, done.
17     Resolving deltas: 100% (296/296), done.
18
19     => Appending source string to /root/.profile
20     => Close and reopen your terminal to start using NVM
21
22     # nvm ls-remote
23     v0.1.14 ... ...      ...
24     ...
25     ...     ... v0.10.17 ...
26     ...     ... ...      ...
27
28     # nvm install 0.10.17
29     ######################################################################## 100.0%
30     Now using node v0.10.17
31
32     # nvm ls
33     v0.10.7
34     current:   v0.10.17
35
36     # npm install -g grunt-cli
37     # npm install -g bower
38
39     # git clone http://github.com/ekarlso/opendaylight-ui
40     # cd opendaylight-ui
41     # npm install
42
43 #### Install and copy bower deps
44
45     # grunt bower
46
47 Starting a webserver using the grunt command
48 --------------------------------------------
49 The below steps will also open a webbrowser towards the server on localhost.
50
51 None of the below tasks will perform minification except Production
52
53 #### Development Environment
54 Does not reload in the browser when you do changes but updates files on
55 changes.
56
57     # grunt dev
58
59 #### Live Development Environment
60 This updates all the files and reloads the page in the browser for each each
61 time a file is changes (Recommended)
62
63     # grunt live
64
65 #### Production Environment
66
67     # grunt prod
68
69
70 OpenDaylight NB API Documentation
71 =================================
72
73 https://wiki.opendaylight.org/view/OpenDaylight_Controller:REST_Reference_and_Authentication