cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3,083 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
1fab59af9e
Go to file
dependabot[bot] 1fab59af9e Bump js-yaml from 3.12.0 to 3.13.1 (#631) 
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.0 to 3.13.1.
- [Release notes](https://github.com/nodeca/js-yaml/releases)
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.12.0...3.13.1)

Signed-off-by: dependabot[bot] <support@github.com>
2019-11-12 13:29:32 +01:00
config/environments Default to stdout logging on dev environment 2019-10-17 13:02:13 +02:00
docs Professional -> Individual 2019-09-02 17:30:46 +02:00
lib Attach error middleware to api router instead of for each controller 2019-11-12 10:11:05 +01:00
test Leave me alone JSHint 2019-10-15 13:42:11 +02:00
.gitignore Merge branch 'master' of github.com:CartoDB/CartoDB-SQL-API 2019-10-08 10:05:44 +02:00
.jshintignore Format files split into pg and ogr directories 2015-05-13 15:15:53 +02:00
.jshintrc Allow es6 syntax 2017-08-04 17:11:45 +02:00
.travis.yml Allow to test against different docker images 2019-04-10 10:55:40 +02:00
app.js Rely on defaults (server-options) for routes configuration 2019-10-07 14:38:21 +02:00
carto-package.json Drop support for Node.js 6, npm 3, Postgres 9.5, PostGIS 2.2, and Redis 3 2019-02-21 18:55:27 +01:00
configure Have ./configure tolerate unknown options 2014-10-08 10:12:52 +02:00
CONTRIBUTING.md Fixed wrong contributing url 2017-01-25 10:49:29 +01:00
docker-bash.sh bash with new docker image 2019-02-12 18:53:12 +01:00
docker-test.sh Allow to test against different docker images 2019-04-10 10:55:40 +02:00
HOWTO_RELEASE Typo 2019-02-22 12:56:51 +01:00
LICENSE Adds notes about contributing 2015-09-08 16:40:33 +02:00
Makefile Changed folder structure to reflect application functionallity. Renamed files using hyphens instead of underscore to have a more consistent naming across the whole project 2019-10-03 18:24:39 +02:00
NEWS.md Update NEWS 2019-11-12 10:12:23 +01:00
package-lock.json Bump js-yaml from 3.12.0 to 3.13.1 (#631) 2019-11-12 13:29:32 +01:00
package.json Update cartodb-query-tables to version 0.7.0 2019-10-21 16:20:52 +02:00
README.md Imporve doc 2019-02-22 12:11:30 +01:00

README.md

SQL API for carto.com

Build Status

Provides a node.js based API for running SQL queries against CartoDB.

  • Users are authenticated over OAuth or via an API KEY.
  • Authenticated requests to this API should always be made over SSL.

Requirements

  • Node 10.x
  • npm 6.x
  • PostgreSQL >= 10.0
  • PostGIS >= 2.4
  • CARTO Postgres Extension >= 0.24.1
  • Redis >= 4
  • GDAL 1.11.0 (bin utils). See installing GDAL
  • zip commandline tool.
  • C++11 (to build internal dependencies if needed)

Install dependencies

$ npm install

Usage

Create and edit config/environments/.js from .js.example files. You may find the ./configure script useful to make an edited copy for you, see ./configure --help for a list of supported switches.

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

Make sure your PostgreSQL server is running, is accessible on the host and port specified in the file, has a 'publicuser' role (or whatever you set db_pubuser configuration directive to) and trusts user authentication from localhost connections.

node app.js <environment>

Supported values are development, test, production

See doc/API.md for API documentation. For examples of use, see under test/.

Tests

Run with:

$ npm test

If any issue arise see test/README.md

Note that the environment should be set to ensure the default PostgreSQL user is superuser (PGUSER=postgres make check).

Contributing

See CONTRIBUTING.md.