qryq server

A server for qryq

Purpose

Many who have watched me give a talk on qryq (slide deck here), have asked, "so, how do I actually start using this library?"

My answer to that would be that it is a general purpose library, just follow the instructions on the main README.md on the qryq page, and use its unit tests as a reference for how to put it all together.

Make it even easier

Each time though, I thought, perhaps I could do one better than that. Greg suggested that I create a sample server that exposed a qryq end point.

Here it is!

How to use this project

Do not git clone this project, unless of course you wish to contribute to this project.

Instead, download a copy of qryq-server, and then copy its extracted contents into your own project.

cd path/to/your/project
wget https://github.com/bguiz/qryq-server/archive/master.zip
unzip master.zip
mv qryq-server-master/* .
rm -r master.zip qryq-server-master

Next modify api.js to include the functions you want to expose via a qryq endpoint, and run the server

#edit api.js
node server.js

Note that if your project already has the server defined, or you wish to use something other than express, you will need to copy selectively from these files.

Putting it together

Once you have started the server, enter the following commands to verify that the server works.

Test that serving static files works:

curl -i -X GET http://localhost:9999/static/index.html

Test that non-qryq end point works:

curl -i -X GET http://localhost:9999/hello

Test that qryq end point works:

curl -i -X POST \
-d '[
{"id": "A", "api": "add", "qry":{"a":3, "b":4}},
{"id": "B", "api": "multiply", "qry":{"a":"#{A}", "b":3}},
{"id": "C", "api": "multiply", "qry":{"a":7, "b": "#{A}"}},
{"id": "D", "api": "add", "qry":{"a":"#{C}", "b":"#{B}"}}
]' \
http://localhost:9999/api/v1/qryq

© Brendan Graetz 2013

GPL v3