Skip to content
Newer
Older
100644 84 lines (55 sloc) 2.75 KB
cdfcb35 @s3u Init
s3u authored
1
1875815 @s3u Update versions
s3u authored
2 [![ql.io](http://ql.io/images/ql.io-large.png)](http://ql.io)
eef60ba @s3u Update README
s3u authored
3
1875815 @s3u Update versions
s3u authored
4 ql.io is a declarative, data-retrieval and aggregation gateway for quickly consuming HTTP APIs. See
5 [ql.io](http://ql.io) for docs, demos and examples.
b472ece @s3u Update with link to temp docs.
s3u authored
6
897c6c9 @s3u Update README to add travis ci status
s3u authored
7 ![Travis status](https://secure.travis-ci.org/ql-io/ql.io.png)
8
43600a1 @s3u Update README
s3u authored
9 ## How to Build ql.io
4c1e2f2 @s3u Update README, Add AUTHORS
s3u authored
10
5c24329 @s3u Update README and add change log.
s3u authored
11 To build ql.io on your own, you need node (version 0.6.0 or later) and npm. In Ubuntu, you need
12 libexpat-dev additionally. Once you have these set up, do the following:
7cb4184 @s3u Update README
s3u authored
13
ec11453 @prabhakhar CHANGE GIT CLONE URL TO READ-ONLY GIT URL IN README.md
prabhakhar authored
14 git clone git://github.com/ql-io/ql.io.git
7cb4184 @s3u Update README
s3u authored
15 cd ql.io
16 make install
17
44452fd @prabhakhar Modified README to install libexpat
prabhakhar authored
18 **Note** If you get "ERR! Error: EACCES, Permission denied" errors, please take a look
19 at [npm issue #194](https://github.com/isaacs/npm/issues/194) and
20 [what-no-sudo](http://foohack.com/2010/08/intro-to-npm/#what_no_sudo).
92fee49 @prabhakhar Modified README to install libexpat and addded a note to handle EACCE…
prabhakhar authored
21
4c1e2f2 @s3u Update README, Add AUTHORS
s3u authored
22 These steps will link ql.io modules locally so can you refer to those modules from your apps using
23 `npm link`.
24
eef60ba @s3u Update README
s3u authored
25 To run tests
26
27 make test
28
29 ql.io source is organized into several modules that you can test independently.
30
31 cd modules/engine
32 make test
33
43600a1 @s3u Update README
s3u authored
34 ## Using ql.io as a Stand-Alone Server
0ad0870 @s3u Update README
s3u authored
35
8f851fc @s3u Update README
s3u authored
36 If you are interested in using ql.io as a stand-alone server, setup a new ql.io app and start the
37 server.
7cb4184 @s3u Update README
s3u authored
38
9a46b84 @s3u Change steps for app setup
s3u authored
39 mkdir myapp
8f851fc @s3u Update README
s3u authored
40 cd myapp
9a46b84 @s3u Change steps for app setup
s3u authored
41 curl https://raw.github.com/ql-io/ql.io/master/modules/template/init.sh | bash
8f851fc @s3u Update README
s3u authored
42 bin/start.sh
43
44 Using latest versions of Firefox or Chrome, go to
d19182a @s3u Fix typo.
s3u authored
45 [http://localhost:3000](http://localhost:3000) to see ql.io's Web Console. See the
8f851fc @s3u Update README
s3u authored
46 [Quickstart Guide](http://ql.io/docs/quickstart) for more details.</p>
7cb4184 @s3u Update README
s3u authored
47
43600a1 @s3u Update README
s3u authored
48 ## Using ql.io in a Node App
0ad0870 @s3u Update README
s3u authored
49
7cb4184 @s3u Update README
s3u authored
50 If you are interested in using ql.io in your node app, use
51
52 npm install ql.io-engine
53
54 After that you can simply execute the core engine.
6d4540f @prabhakhar Example for executing ql.io engine in a node app
prabhakhar authored
55
56 var Engine = require('ql.io-engine');
7cb4184 @s3u Update README
s3u authored
57 var engine = new Engine({
6d4540f @prabhakhar Example for executing ql.io engine in a node app
prabhakhar authored
58 connection: 'close'
7cb4184 @s3u Update README
s3u authored
59 });
0ad0870 @s3u Update README
s3u authored
60
6d4540f @prabhakhar Example for executing ql.io engine in a node app
prabhakhar authored
61 var script = "create table geocoder " +
f93dd03 @s3u Align example
s3u authored
62 " on select get from 'http://maps.googleapis.com/maps/api/geocode/json?address={address}&sensor=true' " +
63 " resultset 'results.geometry.location'" +
64 "select lat as lattitude, lng as longitude from geocoder where address='Mt. Everest'";
6d4540f @prabhakhar Example for executing ql.io engine in a node app
prabhakhar authored
65
5c24329 @s3u Update README and add change log.
s3u authored
66 engine.execute(script, function(emitter) {
d273867 @s3u Minor fixes
s3u authored
67 emitter.on('end', function(err, res) {
68 console.log(res.body[0]);
69 });
f93dd03 @s3u Align example
s3u authored
70 });
6d4540f @prabhakhar Example for executing ql.io engine in a node app
prabhakhar authored
71
43600a1 @s3u Update README
s3u authored
72 ## Making Contributions
0ad0870 @s3u Update README
s3u authored
73
3a12b3c @s3u Add CLA blurb
s3u authored
74 Fixes and features via pull requests are welcome as long as the contributor agrees to the
75 [Contributor License Agreement](https://github.com/downloads/ql-io/ql.io/ql.io-CLA.pdf). Print,
76 sign, and email a scanned copy to subbu/AT/ebaysf/DOT/com before submitting the first pull request.
77
78 To help move pull requests quickly, consider socializing your idea in the
79 [email group](http://groups.google.com/group/qlio).
0ad0870 @s3u Update README
s3u authored
80
43600a1 @s3u Update README
s3u authored
81 ## Discussions
0ad0870 @s3u Update README
s3u authored
82
adc349a @s3u Poke for branching
s3u authored
83 Subscribe to the [google group](http://groups.google.com/group/qlio).
Something went wrong with that request. Please try again.