|
81
by kapil.foss at gmail
add readme with developer install |
1 |
Developer Install
|
2 |
-----------------
|
|
3 |
||
4 |
Juju GUI uses nodejs based development tools. |
|
5 |
||
6 |
You'll need nodejs & npm from the ppa:: |
|
7 |
||
8 |
sudo add-apt-repository ppa:chris-lea/node.js |
|
9 |
sudo apt-get update |
|
10 |
sudo apt-get install nodejs npm |
|
11 |
||
|
82.2.2
by Gary Poster
respond to review |
12 |
The linter will be installed locally per branch, but if you want editor |
13 |
integration, you may want to install jshint globally in your system. |
|
|
82.2.1
by Gary Poster
Make some simple readme changes, and remove the unnecessary dependency on gnome-open, which was removed in precise, in favor of xdg-open. |
14 |
|
15 |
sudo npm install -g jshint |
|
16 |
||
17 |
For building the docs, you also need sphinx. |
|
18 |
||
19 |
sudo apt-get install python-sphinx |
|
|
81
by kapil.foss at gmail
add readme with developer install |
20 |
|
21 |
The gui frontend can be installed with:: |
|
22 |
||
23 |
bzr branch lp:juju-ui trunk |
|
24 |
cd trunk |
|
25 |
make server |
|
26 |
||
27 |
||
28 |
You'll also need to deploy a juju environment with REST api |
|
29 |
access. Currently that work resides in a pipeline of juju |
|
30 |
branches. The recommended branch to utilize as a server is |
|
31 |
``lp:~hazmat/juju/rapi-delta``.
|
|
32 |
||
33 |
||
34 |
You can utilize it with any environment, but for dev purposes, a |
|
35 |
local environment works well. One environment option specific to this |
|
36 |
branch is the api-port. A sample configuration appropriate:: |
|
37 |
||
38 |
default: dev |
|
39 |
environments: |
|
40 |
dev: |
|
41 |
type: local |
|
42 |
data-dir: /home/kapil/.juju/local |
|
43 |
admin-secret: b3a5dee4fb8c4fc9a4db04751e5936f4 |
|
44 |
default-series: precise |
|
45 |
juju-origin: ppa |
|
46 |
api-port: 8081 |
|
47 |
||
48 |
Note juju-origin is set to the ppa, the api server runs outside of |
|
49 |
the container, and is launched using whichever branch your using. |
|
|
147.1.1
by Nicola Larosa
Moved the style guide into docs, first cleanup. |
50 |
|
|
81
by kapil.foss at gmail
add readme with developer install |
51 |
Also note the api-port should be spec'd at 8081, which the gui's |
52 |
initial environment connection currently defaults to. |
|
53 |
||
54 |
You'll need to bootstrap the local environment, and deploy one |
|
55 |
service. The api server needs access to the provisioning credentials |
|
56 |
which are lazy initialized in juju upon usage. |
|
57 |
||
|
147.1.1
by Nicola Larosa
Moved the style guide into docs, first cleanup. |
58 |
After which the gui should be functional (it automatically polls the |
|
81
by kapil.foss at gmail
add readme with developer install |
59 |
api server for establishing a websocket). |
|
147.1.1
by Nicola Larosa
Moved the style guide into docs, first cleanup. |
60 |
|
61 |
||
|
81
by kapil.foss at gmail
add readme with developer install |
62 |
Running unit tests.
|
63 |
-------------------
|
|
64 |
||
|
82.2.1
by Gary Poster
Make some simple readme changes, and remove the unnecessary dependency on gnome-open, which was removed in precise, in favor of xdg-open. |
65 |
xdg-open test/index.html |
66 |
||
67 |
||
|
197.1.5
by Benji York
- add all the yuidoc dependencies (hopefully) |
68 |
Documentation
|
69 |
-------------
|
|
70 |
||
71 |
Generated JavaScript documentation is available in the yuidoc directory. Start |
|
72 |
with the index.html file. You can view the docs by running this command::
|
|
73 |
||
74 |
xdg-open yuidoc/index.html
|
|
75 |
||
|
197.1.6
by Benji York
add another note about the docs to the README |
76 |
To regenerate the docs run this command::
|
77 |
||
78 |
make yuidoc
|
|
79 |
||
|
197.1.7
by Benji York
review changes |
80 |
The documentation for yuidoc markup is at http://yui.github.com/yuidoc/syntax/. |
81 |
||
|
197.1.5
by Benji York
- add all the yuidoc dependencies (hopefully) |
82 |
|
|
82.2.1
by Gary Poster
Make some simple readme changes, and remove the unnecessary dependency on gnome-open, which was removed in precise, in favor of xdg-open. |
83 |
Running lint
|
84 |
------------
|
|
85 |
||
86 |
jshint --config=jshint.config `bzr ls -RV -k file | grep -v assets/`
|
|
|
147.1.1
by Nicola Larosa
Moved the style guide into docs, first cleanup. |
87 |
|
|
135.1.1
by Benji York
add beginings of a style guide |
88 |
|
89 |
Style
|
|
90 |
-----
|
|
91 |
||
|
147.1.1
by Nicola Larosa
Moved the style guide into docs, first cleanup. |
92 |
See the docs/style-guide.rst file for the project style guide. |