README.md

sakila API GraphQL Wrapper

A wrapper around sakila API built using GraphQL.

Uses:

• graphql-js - a JavaScript GraphQL runtime.
• DataLoader - for coalescing and caching fetches.
• express-graphql - to provide HTTP access to GraphQL.
• GraphiQL - for easy exploration of this GraphQL server.

Getting Started

The project is built with typescript so ensure that the typescript compiler is installed.

$ tsc -v # global installation
Version 2.7.2 # At the time of writing

Install dependencies with

$ npm install

Testing

Running:

$ npm test

will compile the project and run the tests using ava located in ./api and ./schema

Local Server

A local express server is in ./server. It can be run with:

$ npm start

or using ts-node in dev mode

$ npm start:dev

A GraphiQL instance will be opened at http://localhost:3000/ (or similar; the actual port number will be printed to the console) to explore the API.