getting-started.md

Getting Started

• Installation
• CLI
• Setup a GraphQL-Server
• Programmers Guide

Installation

SubKit GraphQL-Server is super easy to set up. Just npm install -g subkit, write a GraphQL schema, and then use one of the following snippets to get started. For more info, read the SubKit GraphQL-Server docs.

npm install -g subkit

CLI

subkit help

Usage: subkit [options] [command]


Options:

  -V, --version  output the version number
  -h, --help     output usage information


Commands:

  create|new <folder>  Creates a GraphQL-API application.
  serve                Serves a GraphQL-API application.
  request|req          Executes GraphQL requests.
  jwt                  Decodes/Encodes JSON Web Tokens.
  help [cmd]           display help for [cmd]

Setup a GraphQL-Server

subkit create mygraphql
cd mygraphql

npm test #Test environment
npm run dev #Development environment
npm start #Production environment

Programmers Guide

coming soon