diff --git a/README.md b/README.md index 02b59e7f..112d25c8 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,4 @@ We will also include multiple PoC's of various bits of functionality from UI's p ### triton-graphql -An implementation of the triton API's in GraphQL. +An implementation of the [Joyent CloudAPI](https://apidocs.joyent.com/cloudapi/) in GraphQL. diff --git a/triton-graphql/README.md b/triton-graphql/README.md index 6ec6a9bf..2c7426f3 100644 --- a/triton-graphql/README.md +++ b/triton-graphql/README.md @@ -2,15 +2,11 @@ Proof-of-Concept of the Triton API running on GraphQL. -### install dependencies +## Setup -```bash -$ npm install -``` +### Setup Credentials -### setup credentials - -Edit `credentials.json` +Create `credentials.json`, TODO, use environment variables. ```json5 { @@ -21,7 +17,20 @@ Edit `credentials.json` } ``` -## api +### Install Dependencies and run + +```bash +npm install +npm start +``` + +### Visit GraphiQL + +Go-to http://0.0.0.0:3000/graphql to use the REPL with interactive documentation. + +![GraphiQL](https://cloud.githubusercontent.com/assets/524382/19242455/1e371978-8f0b-11e6-9563-d6f5b93fa63c.png) + +## API - [x] Account - [x] GetAccount diff --git a/triton-graphql/package.json b/triton-graphql/package.json index 1a609697..8facfcb1 100644 --- a/triton-graphql/package.json +++ b/triton-graphql/package.json @@ -4,6 +4,9 @@ "license": "Apache-2.0", "version": "1.0.0", "main": "src/index.js", + "scripts": { + "start": "node src/index.js" + }, "dependencies": { "bunyan": "^1.8.1", "express": "^4.14.0",