Skip to content
Generate a GraphQL schema for any PostgreSQL database using the database schema information
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
util
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package-lock.json
package.json

README.md

Graphfront

Use a PostgreSQL database schema information to generate a GraphQL schema.

This is a work-in-progress project. It requires a super recent version of Node.js and using it in production is not recommended.

Build Status npm version

Getting Started

An overview of GraphQL in general is available in the README for the Specification for GraphQL.

Using Graphfront

Install Graphfront from npm

npm install --save graphfront

Graphfront provides two important capabilities: generating a GraphQL schema, and exposing an HTTP handler to server requests for that schema.

First, generate a GraphQL schema based on a database schema.

import { generator } from 'graphfront';

const { getSchema } = generator(dbPool, apiKeyValidator);

This defines a function that can be invoked to generate a schema.

Or you can use request handler that automatically generates the schema

const graphfront = require('graphfront');

const graphfrontHTTP = graphfront({
  dbPool,
  apiKeyValidator: (apiKey) => apiKey === 'SuperSecretKey'
});

app.use('/my-api', graphfrontHTTP);

Contributing

We actively welcome pull requests, learn how to contribute.

Changelog

Changes are tracked as Github releases.

License

Graphfront is released under the MIT license.

You can’t perform that action at this time.