Manage restQL queries
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
public
src
.dockerignore
.editorconfig
.eslintrc
.gitignore
.travis.yml
.yarnclean
Dockerfile
LICENSE
Procfile
README.md
package.json
yarn.lock

README.md

Build Status

Running restQL Manager

restQL Manager allows you to easily develop and test new queries, save resources endpoints, check resources status and save queries that can be used by clients just referencing the query's name.

restQL Manager requires a restQL-server running instance.

Installation

restQL Manager is available through npm, and can be installed with npm install -g restql-manager

Once installed, you can simply run restql-manager from the shell and it will start.

Configuration

restQL Manager uses the following environment variables for its configuration:

  • RESTQL_SERVER_URL. This MUST point to a running restQL-server instance
  • RESTQL_MANAGER_PORT. Default is 3000. Set this variable to change the TCP port to be bound.
  • MONGO_URL. This should point to the same mongoDB instances used by the referenced restQL-server.

Development server

To install restQL manager dependecies run:

yarn install

To start the development server, run:

yarn server:start

In another shell, run:

yarn start

Access http://localhost:5000/.

Production build

To build a production bundle, run:

yarn build

You can now start the server:

node src/server

restQL-manager will be available at http://localhost:3000/