antonoberg / subzero-cli Goto Github PK

View Code? Open in Web Editor NEW

Tooling to aid development of subZero/PostgREST based backend APIs

License: GNU General Public License v3.0

Dockerfile 1.70% JavaScript 98.30%

subzero-cli's Introduction

subZero CLI

This tool is meant to be used with the Docker based starter kits for PostgREST and subZero.

After installing, executing the command in the root of your project will give you this interface.

Features

✓ Convenient interface to view the logs of all stack components
✓ Live code reloading (for SQL/Lua/Nginx configs)
✓ Database schema migration management
✓ Community support on Slack

Prerequisites

✓ Docker ✓ Node.js

Install

Use npm to install the subzero developer tools

  docker pull subzerocloud/subzero-cli-tools # install the helper docker image
  npm install --global --production windows-build-tools # windows ONLY!!!
  npm install -g subzero-cli # install the cli
  subzero --help # check it was installed

Installing from source

After cloning the repo, run these commands.

  npm install
  npm run build
  npm link

This will create a command available in your PATH called subzero.

To rebuild and recreate the command do:

  npm run build && npm unlink subzero && npm link

License

Copyright © 2017-present subZero Cloud, LLC.
This source code is licensed under the GPLv3
The documentation to the project is licensed under the CC BY-SA 4.0 license.

Recommend Projects