Skip to content
Newer
Older
100644 68 lines (45 sloc) 2.75 KB
40f056a @WardCunningham readme as challenge
authored Jun 25, 2011
1 Client Goals
2 ============
3
21f4e75 @WardCunningham elaborate purpose
authored Jun 25, 2011
4 A server offers direct restful read/write access to pages it owns and proxy access to pages held elsewhere in federated space.
5 A page is owned if it was created with the server or has been cloned and edited such that it is believed to be the most authoritative copy of a page previously owned elsewhere.
6 A server operates as a proxy to the rest of the federated wiki.
7 In this role it reformats data and metadata providing a unified experience.
8 It is welcome to collect behavioral statistics in order to improve this experience by anticipating permitted peer-to-peer server operations.
5c93a66 @WardCunningham tip: blank lines before bullets in markdown
authored Jul 20, 2011
9
21f4e75 @WardCunningham elaborate purpose
authored Jun 26, 2011
10 In summary, the server's client side exists to:
5c93a66 @WardCunningham tip: blank lines before bullets in markdown
authored Jul 21, 2011
11
21f4e75 @WardCunningham elaborate purpose
authored Jun 26, 2011
12 * Offer to a user a browsing experience that is independent of any specific server.
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
13 * Support writing, editing and curating of one server in a way that offers suitable influence over others.
14
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
15 Working with Browserify
16 =======================
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
17
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
18 The client side is written in CoffeeScript, and built with Browserify.
19 If you are not checking in changes you need not concern yourself with this.
20 We've checked in the generated Javascript for the client application.
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
21
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
22 If you do want to check in changes, install node v0.6.x
d4f9342 @nrn Fix OS list in ReadMe.
nrn authored Apr 15, 2012
23
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
24 * On Linux download the source from [GitHub](https://github.com/joyent/node)
25 * On Windows get the installer from the [main node.js site](http://nodejs.org).
26 * On Mac you should be able to choose either.
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
27
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
28 Once node is installed come back to this directory and run:
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
29
4c6e36c @nrn Moved the information from notes.md into ReadMe.md
nrn authored Apr 15, 2012
30 * `npm install` To install CoffeeScript, Browserify, and all their dependencies.
31
32 You can now use:
33
34 * `npm start` To build the main client.
35 * `npm test` To build the test client.
36
37 These commands build client.js and test/testclient.js from client.coffee and
38 testclient.coffee respectively. They use their entry files to require the
39 rest of the coffee script they need from the source CS files in /lib.
40
41 We also have a cool automated talking (Mac only) Perl build script that uses
42 a globally installed browserify via `npm install -g browserify`, it watches
43 for changes, builds the clients automatically, and gives a verbal report
44 when you have syntax errors.
45
46 Testing
47 =======
48
49 All the client tests can be run by visiting /runtests.html on your server
50 or by running the full ruby test suite. Information about the libraries we
51 are using for testing can be found at:
52
53 * http://visionmedia.github.com/mocha/
54 * https://github.com/LearnBoost/expect.js
55 * http://sinonjs.org/
56
57 CoffeeScript hints
58 ==================
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
59
9882d98 @Erkan-Yilmaz small changes + same format in Readme files
Erkan-Yilmaz authored Jan 23, 2012
60 We recommend taking time to learn the CoffeeScript syntax and the rationale for the Javascript idioms it employs. Start here:
74ab8fe @WardCunningham move and enlarge coffeescript info
authored Aug 1, 2011
61
62 http://jashkenas.github.com/coffee-script/
63
64 We used a Javascript to Coffeescript converter to create the first draft of client.coffee. You may find this converter useful for importing sample codes.
65
66 http://ricostacruz.com/js2coffee/
93087b0 @SvenDowideit add some hints that might help someone start developing faster
SvenDowideit authored Sep 27, 2011
67
Something went wrong with that request. Please try again.