Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 113 lines (63 sloc) 3.519 kb
a608d33 Dav Glass Initial Import
authored
1 h1. YUI Bootstrapper for Node.js
2
fb021b7 Dav Glass README Updates
authored
3 The YUI3NodeJS project uses several 3rd party open source libraries and tools.
96cb880 Dav Glass README Updates
authored
4
5 This file summarizes the tools used, their purpose, and the licenses under which they're released.
6
a608d33 Dav Glass Initial Import
authored
7 This node.js module attempts to setup and bootstrap a working YUI 3 instance.
8
45e90aa Dav Glass Updated README with new IO calls
authored
9 This module includes support for remote script loading via Y.Get.script() and remote data fetching via Y.io.
a608d33 Dav Glass Initial Import
authored
10
04778c4 Dav Glass Moved around source and examples
authored
11 See "JSDom Support" below for DOM manipulation.
12
13 h2. Node.js
14
d06e29f Dav Glass README Updates
authored
15 All of the examples and tests assume you have @node@ in your path and they are all executable.
a608d33 Dav Glass Initial Import
authored
16
7e92618 Dav Glass Updated README
authored
17 h2. Dependencies
2f5f618 Dav Glass Added deps to README
authored
18
1f51e6d Dav Glass Many updates
authored
19 All dependencies are installed when you install the yui3 package via @npm@
20
21 For server side dom manipulation, you need the following packages installed:
22
96cb880 Dav Glass README Updates
authored
23 "JSDom":http://github.com/tmpvar/jsdom : "LICENSE":http://github.com/tmpvar/jsdom/blob/master/LICENSE.txt
1f51e6d Dav Glass Many updates
authored
24
25 <pre class="console">npm install jsdom</pre>
26
96cb880 Dav Glass README Updates
authored
27 "HTML Parser":http://github.com/tautologistics/node-htmlparser : "LICENSE":http://github.com/tautologistics/node-htmlparser/blob/master/LICENSE
5c83119 Dav Glass Updated README and removed submodule
authored
28
1f51e6d Dav Glass Many updates
authored
29 <pre class="console">npm install htmlparser</pre>
30
31 h2. Optional Dependancies
32
33 "Express":http://expressjs.com/ : LICENSE (MIT)
34
35 <pre class="console">npm install express</pre>
36
2069eaf Dav Glass Updated README
authored
37 "Connect":http://github.com/senchalabs/connect : LICENSE (MIT)
1f51e6d Dav Glass Many updates
authored
38
39 <pre class="console">npm install connect</pre>
40
62c75ff Dav Glass README updated
authored
41 h2. Installing - via NPM
a608d33 Dav Glass Initial Import
authored
42
62c75ff Dav Glass README updated
authored
43 <pre class="console">
44 npm install yui3
45 </pre>
a608d33 Dav Glass Initial Import
authored
46
62c75ff Dav Glass README updated
authored
47 h2. Installing - as a developer
bc5be79 Dav Glass Updated README
authored
48
1f51e6d Dav Glass Many updates
authored
49 You must have git and npm installed before you can develop.
50
bc5be79 Dav Glass Updated README
authored
51 <pre class="console">
62c75ff Dav Glass README updated
authored
52 git clone git://github.com/davglass/nodejs-yui3.git
1f51e6d Dav Glass Many updates
authored
53 cd nodejs-yui3/
aa75a4b Dav Glass Removing old build files and updated README
authored
54 npm install .
bc5be79 Dav Glass Updated README
authored
55 </pre>
a608d33 Dav Glass Initial Import
authored
56
8db703f Dav Glass Finishing up some docs - npm published
authored
57 h2. Using YUI3
58
59 "This is the general-dom example":http://gist.github.com/541501
60
b70e762 Dav Glass Minor README update
authored
61 h2. Remote Fetching
62
63 "This example shows fetching a remote document and then using Node to modify it":http://gist.github.com/574000
8db703f Dav Glass Finishing up some docs - npm published
authored
64
c4facb3 Dav Glass Added Y Browser example
authored
65 h2. Using the Y.Browser object
66
67 To comply with the "no-globals" CommonJS spec, there is no global document or window in this mode.
68 Just including the nodejs-dom module will create a fake dom for this instance.
69 You can create a document like this:
d06e29f Dav Glass README Updates
authored
70 "View this Gist":http://gist.github.com/359776
71
72 You can make older DOM code run by setting up a couple of local variables, "like this":http://gist.github.com/359778
c4facb3 Dav Glass Added Y Browser example
authored
73
74
75 If you are using YUI to serve pages, you should use a Nested Use to create the document when the request comes in.
76
d06e29f Dav Glass README Updates
authored
77 "Something like this":http://gist.github.com/359781
c4facb3 Dav Glass Added Y Browser example
authored
78
79
3923dca Dav Glass README updates
authored
80 I have an example showing this: @examples/y-browser.js@
c4facb3 Dav Glass Added Y Browser example
authored
81
82
04778c4 Dav Glass Moved around source and examples
authored
83 h2. Examples
a608d33 Dav Glass Initial Import
authored
84
85 <pre class="console">
04778c4 Dav Glass Moved around source and examples
authored
86 cd examples/
87 ./general-dom.js
88 ./io.js
89 ./library.js
3923dca Dav Glass README updates
authored
90 ./y-brower.js
a608d33 Dav Glass Initial Import
authored
91 </pre>
92
04778c4 Dav Glass Moved around source and examples
authored
93 h2. Tests
94
95 When using JSDom, All relevent YUI 3 Dom & Selector tests pass. The ones that are skipped revolve around styles and postioning. Since there is no window or CSS cascade, these seem unimportant at the moment.
a608d33 Dav Glass Initial Import
authored
96
7e92618 Dav Glass Updated README
authored
97 Testing is pretty simple now once you install `yuitest`:
4cc3ba8 Dav Glass Some updates for the RLS implementation
authored
98
a608d33 Dav Glass Initial Import
authored
99 <pre class="console">
7e92618 Dav Glass Updated README
authored
100 npm install yuitest
101 yuitest ./tests/*.js
a608d33 Dav Glass Initial Import
authored
102 </pre>
103
96cb880 Dav Glass README Updates
authored
104 h2. License
105
106 This software is offered under the terms of the BSD license. See the LICENSE file or the "YUI License":http://developer.yahoo.com/yui/license.html for license text and copyright information.
107
108 h2. Contribute
109
110 Your contributions are welcome! Please review the "YUI contributor guide":http://developer.yahoo.com/yui/community/#cla before contributing. If you haven't contributed to a "YUI project":http://yuilibrary.com before, you'll need to review and sign the "YUI CLA":http://developer.yahoo.com/yui/community/#cla before we can accept your pull request.
111
112
Something went wrong with that request. Please try again.