bekerov / graphiqlide

Tarantool Cartridge WebUI GraphiQL IDE plugin

Tarantool Cartridge WebUI GraphiQL IDE plugin

This plugin is used to add GrapiQL IDE functionality into Tarantool Cartridge WebUI

Based on:

• Tarantool 2.x.x
• Tarantool Cartridge 2.3.0
• Tarantool Frontend Core 7.3.0
• GraphiGL 1.0.5
• GraphiQL Explorer 0.6.2

GraphQLIDE looks like:

Usage

!!! Attention Build tested only on Debian-based GNU linux!

Build

Clone repo

git clone [e-mail]:no1seman/graphiqlide.git graphiqlide
cd graphiqlide
npm i

Build rock

tarantoolctl rocks make
tarantoolctl rocks pack graphqlide version

Also command "npm run build-rock" can be used to to build the rock

After build completion you will get:

• graphiqlide-version.all.rock
• graphiqlide rock installed to graphiqlide/.rocks dir

Install

Install rock

Simply run ./script/install_rock.sh from the root of Tarantool Cartridge App root path or make it manually from console:

cd <Tarantool Cartridge application dir>
tarantoolctl rocks install <path to rock file>/graphqlide-version.all.rock

Add plugin to your Tarantool Cartridge App

To get GraphQLIDE work just add to Tarantool Cartridge application init.lua the following code:

require('graphqlide').init()

Development

For debug & development purposes VS code will be used. Use F5 to run app or Shift-Crtl-B to run production build task

Useful commands:

• npm run build - builds production project
• npm run start - run application without need to integrate it into Tarantool Cartridge App. Useful for development purposes
• npm run build-rock - builds production project and bundles it into rock