sketch-canvas

README

Sketch Canvas

Quick Start

You can use docker-compose to run the whole stack:

$ docker-compose up

The server will be available at http://localhost:8800. If the port is not available, you can customize the port by editing the canvas command in docker-compose.yml.

You can check the API documentation for instruction on how to access the server.

Postman

You can use Postman to test the API directly. Use the provided postman collection file to get predefined queries to use with the server.

Command line parameters

-s, --datastore string            the hostname of the redis datastore (default "localhost:6379")
    --datastore-db int            the database to be selected on the redis server
    --datastore-password string   the password of the redis server
    --debug                       debug mode
-w, --graceful-timeout duration   the duration for which the server gracefully wait for existing connections to finish - e.g. 15s or 1m (default 15s)
-p, --port int                    the port number of the canvas server (default 8800)
-v, --verbose                     verbose mode