Go to file

tokumine 95509bd8a3 Merge pull request #15 from strk/readme wrap to 80 cols		2012-03-16 03:29:12 -07:00
app	fixed oauth problems with POST requests fixes #10	2011-12-26 12:51:15 +01:00
config	by default cluster.js binds to 127.0.0.1 instead of 0.0.0.0	2012-02-09 16:53:21 +01:00
logs	updated gitignore and added required directories for node cluster to work out of the box	2011-09-05 17:01:23 +01:00
pids	updated gitignore and added required directories for node cluster to work out of the box	2011-09-05 17:01:23 +01:00
test	Another 80cols wrap	2012-03-14 11:02:32 +01:00
.gitignore	updated gitignore and added required directories for node cluster to work out of the box	2011-09-05 17:01:23 +01:00
app.js	quick tidy	2011-10-07 17:28:07 +01:00
cluster.js	by default cluster.js binds to 127.0.0.1 instead of 0.0.0.0	2012-02-09 16:53:21 +01:00
LICENSE	update licence	2011-10-07 17:19:37 +01:00
package.json	tidy geojson, add content-disposition and remove KML for now. Closes #7	2011-10-28 12:11:18 +01:00
README.md	wrap to 80 cols	2012-03-13 19:32:01 +01:00
TODO.md	add notes on locking cache	2011-09-20 22:11:33 -03:00

README.md

SQL API for cartodb.com

Provides a nodejs based API for running SQL queries against CartoDB.

Users are authenticated over OAuth. Also provides ability to make public "SELECT" only calls.
OAuth requests to this API should always be made over SSL.

core requirements

pg_bouncer
postgres
redis
node v0.4.8+
npm

usage

Make sure redis is running and knows about active cartodb user.

node [cluster.js|app.js] [developement|test|production]

for examples of use, see /tests

dependencies

npm install

tests

npm test-unit
npm test-acceptance

make sure you have setup your database connections in /config, and have the correct databases and keys setup in redis. You'll at least need to set redis with HSET rails:oauth_tokens:1 user_id 1 for the acceptance tests.