cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #15 from strk/readme

Browse Source 
wrap to 80 cols
This commit is contained in:
tokumine 2012-03-16 03:29:12 -07:00
commit 95509bd8a3
2 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -3,19 +3,11 @@ 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.
* 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.
usage
------
``` bash
node cluster.js/app.js [developement,test,production]
```
for examples of use, see /tests
core requirements
-------------
* pg_bouncer
@ -24,9 +16,20 @@ core requirements
* node v0.4.8+
* npm
usage
-----
Make sure redis is running and knows about active cartodb user.
``` bash
node [cluster.js|app.js] [developement|test|production]
```
for examples of use, see /tests
dependencies
---------------------
------------
```bash
npm install
@ -34,11 +37,13 @@ npm install
tests
------
-----
``` bash
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.
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.

4
test/README.md
View File

@ -1,7 +1,9 @@
cartodb-sql-api tests
--
Tests require you create a test database and set some redis keys before, you can execute prepare_db.sh script, it will create database, users and redis stuff for you. Be sure postgres and redis are running
Tests require you create a test database and set some redis keys before,
you can execute prepare_db.sh script, it will create database, users
and redis stuff for you. Be sure postgres and redis are running
> cd test && ./prepare_db.sh