Installation

!!! This documentation is outdated. New version here.

Docker

Install Docker for you platform.

Git Repo

Clone the repo and launch the app:

mkdir example-api && cd example-api
git clone https://github.com/subzerocloud/postgrest-starter-kit.git .
git remote rename origin upstream && git branch --unset-upstream
docker-compose up -d            # Launch Docker containers

The API server will become available at http://localhost:8080/rest.

Try a simple request

curl http://localhost:8080/rest/todos?select=id,todo

subzero-cli

Install subzero-cli by running

docker pull subzerocloud/subzero-cli-tools
npm install -g subzero-cli

In the root folder of your project run the command

subzero dashboard

You should see a screen like this (From now on, we'll always have this running when iterating on our project)