CartoDB-SQL-API/README.md
2011-06-30 17:10:10 +01:00

45 lines
779 B
Markdown

SQL API for cartodb.com
========================
Provides a concurrent event driven interface for running SQL queries against the cartoDB postgres database. Users are authenticated over oAuth. Also provides ability to make public "SELECT" only calls.
usage
------
``` bash
node cluster.js [developement,test,production]
```
tests
------
``` bash
make test
```
core requirements
-------------
* pg_bouncer
* postgres
* redis
* node v0.4.8+
node.js dependencies
---------------------
* npm
To install dependencies from package.json:
``` npm install```
deployment
----------
* capistrano on ruby 1.9.2.
To install dependencies from Gemfile:
```bundle install```
ensure after first code deploy to run the dependencies task:
```cap production node:npm_dependencies```