https://github.com/subzerocloud/subzero-cli

Tooling to aid development of subZero/PostgREST based backend APIs
https://github.com/subzerocloud/subzero-cli

api postgresql postgrest subzero

Last synced: about 1 month ago
JSON representation

Tooling to aid development of subZero/PostgREST based backend APIs

• Host: GitHub
• URL: https://github.com/subzerocloud/subzero-cli
• Owner: subzerocloud
• License: gpl-3.0
• Archived: true
• Created: 2017-02-06T12:19:03.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:50:25.000Z (over 1 year ago)
• Last Synced: 2024-09-26T15:41:25.817Z (about 1 month ago)
• Topics: api, postgresql, postgrest, subzero
• Language: JavaScript
• Homepage:
• Size: 989 KB
• Stars: 53
• Watchers: 7
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

# subZero CLI

This tool is meant to be used with the Docker based starter kits for [PostgREST](https://github.com/subzerocloud/postgrest-starter-kit/) and [subZero](https://github.com/subzerocloud/subzero-starter-kit/).

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

![subzero-cli](https://raw.githubusercontent.com/wiki/subzerocloud/postgrest-starter-kit/images/postgrest-starter-kit.gif "subzero-cli")

## Features

✓ Convenient interface to view the logs of all stack components


✓ Live code reloading (for SQL/Lua/Nginx configs)


✓ Database schema migration management with auto migration generation using sqitch/migra


✓ Community support on [Slack](https://slack.subzero.cloud/)


## Prerequisites

 ✓ [Docker](https://www.docker.com)

 ✓ [Node.js](https://nodejs.org/en/)

## Install

Use `npm` to install the subzero developer tools

```bash

  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.

```bash

  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:

```bash

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

```

## License

Copyright © 2017-present subZero Cloud, LLC.


This source code is licensed under the [GPLv3](https://github.com/subzerocloud/devtools/blob/master/LICENSE.txt)


The documentation to the project is licensed under the [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/) license.