Get Pave setup in your environment in minutes

5 Minute Setup

This guide will walk you through getting Pave setup and working in your project

Installation

Getting pave setup and running your environment is easy and painless. Naturally, the first step of setup is to install Pave by declaring it in your package.json file in your project, as shown below.

// In your projects package.json
{
  ...
  "dependencies": {
    "pave": "0.11",
  }
}

Once this is included in your dependencies, and npm install is ran, Pave will now be included in your project.

Build the Schema

The cornerstore of any querying language is a rigid schema by which your project’s models are well defined. This is what we’ll build out in the following steps.

The first step is to define your basic scalar types. We have attempted to make this easier by providing a package which includes a lot of the run-of-the-mill scalar types you will want for your project. This package can be included in your project in much the same way as Pave itself; "pave-basic-types": "1"

This package, when spread inside of your root schema file, as shown below, will provide these 8 basic types; string, int, date, datetime, time, number, object, boolean.

As far as these basic types go, it’s up to you as to whether or not you selectively pick and choose which types to use, or whether you just want to use all of them, examples of both are shown below.

All

import basicTypes from 'pave-basic-types';

export default {
  ...basicTypes,
  ...(other, custom, schema types)
}

Selective

import basicTypes from 'pave-basic-types';

const { string, number, object } = basicTypes;

export default {
  string,
  number,
  object,
  ...(other, custom, schema types)
}

Define Functions

A schema without functions is like the day without the night, the land without the water. In order to make the schema matter, one must create root functions which

Implement a Resolver