joyent-portal/packages/cloudapi-gql/README.md

# cloudapi-gql

[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)

Server that exposes [CloudApi](https://apidocs.joyent.com/cloudapi/) through
[GraphQL](http://graphql.org).

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Todo](#todo)
- [License](#license)

## Install

```
yarn add cloudapi-gql
```

## Usage

```
yarn run start
```

- [GraphiQL](http://0.0.0.0:4000/graphiql)
- [Graphidoc](http://0.0.0.0:4000/doc)
- [Voyager](http://0.0.0.0:4000/voyager)
- [Playground](http://0.0.0.0:4000/playground)

![](https://cldup.com/StGgfIbD3N.png) ![](https://cldup.com/fhpul_AJ13.png)
![](https://cldup.com/A-VwSbvWBe.png) ![](https://cldup.com/08P360Skhx.png)

```
yarn run faker
```

- [GraphQL Faker Interactive Editor](http://0.0.0.0:9002/editor)
- [GraphQL Faker API](http://0.0.0.0:9002/graphql)

![](https://cldup.com/VWadVMorQ0.png)

## Todo

- [ ] Finish missing connections, transforms, and mutations
- [ ] remove node-triton dependency
- [ ] support multiple users on the same server

## License

MPL-2.0
chore(cloudapi-gql): s/joyent-portal-cloudapi-gql/cloudapi-gql 2017-10-03 17:02:04 +03:00			`# cloudapi-gql`
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00
docs: add container badges 2017-06-01 00:35:35 +03:00			`[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)`
			`[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)`
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00
style: format markdown 2017-10-12 21:15:51 +03:00			`Server that exposes [CloudApi](https://apidocs.joyent.com/cloudapi/) through`
			`[GraphQL](http://graphql.org).`
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00
			`## Table of Contents`

			`- [Install](#install)`
			`- [Usage](#usage)`
feat(gql-cloudapi): template tag schema re-write - uniform api usage for some models (account/user, networks/vlans/fabrics, etc) - graphidoc, playground, faker, and voyager support - schema in a template tag and documented - apollo-errors - apollo-server-hapi and schema using graphql-tools/makeExecutableSchema - replace express with Hapi - eslint support for graphql - updated dependencies 2017-10-03 13:57:18 +03:00			`- [Todo](#todo)`
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00			`- [License](#license)`

			`## Install`

			```
chore(cloudapi-gql): s/joyent-portal-cloudapi-gql/cloudapi-gql 2017-10-03 17:02:04 +03:00			`yarn add cloudapi-gql`
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00			```

			`## Usage`

			```
			`yarn run start`
			```

style: format markdown 2017-10-12 21:15:51 +03:00			`- [GraphiQL](http://0.0.0.0:4000/graphiql)`
			`- [Graphidoc](http://0.0.0.0:4000/doc)`
			`- [Voyager](http://0.0.0.0:4000/voyager)`
			`- [Playground](http://0.0.0.0:4000/playground)`
feat(gql-cloudapi): template tag schema re-write - uniform api usage for some models (account/user, networks/vlans/fabrics, etc) - graphidoc, playground, faker, and voyager support - schema in a template tag and documented - apollo-errors - apollo-server-hapi and schema using graphql-tools/makeExecutableSchema - replace express with Hapi - eslint support for graphql - updated dependencies 2017-10-03 13:57:18 +03:00
style: format markdown 2017-10-12 21:15:51 +03:00			`![](https://cldup.com/StGgfIbD3N.png) ![](https://cldup.com/fhpul_AJ13.png)`
			`![](https://cldup.com/A-VwSbvWBe.png) ![](https://cldup.com/08P360Skhx.png)`
feat(gql-cloudapi): template tag schema re-write - uniform api usage for some models (account/user, networks/vlans/fabrics, etc) - graphidoc, playground, faker, and voyager support - schema in a template tag and documented - apollo-errors - apollo-server-hapi and schema using graphql-tools/makeExecutableSchema - replace express with Hapi - eslint support for graphql - updated dependencies 2017-10-03 13:57:18 +03:00
			```
			`yarn run faker`
			```

style: format markdown 2017-10-12 21:15:51 +03:00			`- [GraphQL Faker Interactive Editor](http://0.0.0.0:9002/editor)`
			`- [GraphQL Faker API](http://0.0.0.0:9002/graphql)`
feat(gql-cloudapi): template tag schema re-write - uniform api usage for some models (account/user, networks/vlans/fabrics, etc) - graphidoc, playground, faker, and voyager support - schema in a template tag and documented - apollo-errors - apollo-server-hapi and schema using graphql-tools/makeExecutableSchema - replace express with Hapi - eslint support for graphql - updated dependencies 2017-10-03 13:57:18 +03:00
			`![](https://cldup.com/VWadVMorQ0.png)`

			`## Todo`

style: format markdown 2017-10-12 21:15:51 +03:00			`- [ ] Finish missing connections, transforms, and mutations`
			`- [ ] remove node-triton dependency`
			`- [ ] support multiple users on the same server`
feat(gql-cloudapi): template tag schema re-write - uniform api usage for some models (account/user, networks/vlans/fabrics, etc) - graphidoc, playground, faker, and voyager support - schema in a template tag and documented - apollo-errors - apollo-server-hapi and schema using graphql-tools/makeExecutableSchema - replace express with Hapi - eslint support for graphql - updated dependencies 2017-10-03 13:57:18 +03:00
chore: initial lerna setup this shall be a progressive process 2017-05-18 21:21:33 +03:00			`## License`

			`MPL-2.0`