crystal

# 🔮 Graphile's Crystal Monorepo

[![GitHub Sponsors](https://img.shields.io/github/sponsors/benjie?color=ff69b4&label=github%20sponsors)](https://github.com/sponsors/benjie)
[![Discord chat room](https://img.shields.io/discord/489127045289476126.svg)](http://discord.gg/graphile)
[![Follow](https://img.shields.io/badge/BSky-@Graphile.org-006aff.svg)](https://bsky.app/profile/graphile.org)
[![Follow](https://img.shields.io/badge/Mastodon-@Graphile.fosstodon.org-6364ff.svg)](https://fosstodon.org/@graphile)

At Graphile we love GraphQL so much we named ourself for our love of it! This
repository houses many of the Graphile packages that relate to GraphQL (or
relate to the packages that relate to GraphQL, or relate to those package...);
the two headline projects are **Gra*fast*** and **PostGraphile** but there's
many other packages, a fair few of which can be used independently - see below
for more details.

**[Grafast][grafast]**: A cutting-edge planning and execution engine for
GraphQL.js ─ use this as a drop-in replacement for the `execute` method from
GraphQL.js and by moving from traditional resolvers to Gra*fast* "plan
resolvers" you'll be able to leverage the declarative nature of GraphQL requests
to execute your business logic in the most efficient way, leading to reduced
server load and happier customers. Use this if you're building your own GraphQL
schemas and want the best performance and efficiency without having to put much
extra effort in.

**[PostGraphile][postgraphile]**: An incredibly low-effort way to build a well
structured and high-performance GraphQL API backed primarily by a PostgreSQL
database. Our main focusses are performance, automatic best-practices and
customisability/extensibility. Use this if you have a PostgreSQL database and
you want to use it as the "source of truth" for an auto-generated GraphQL API
(which you can still make significant changes to). **NOTE**: thanks to
[graphile-export][] you can also use this as a starting point for an API that
you then manage yourself.

| ➡️ For **PostGraphile V4** see [the `legacy` branch](https://github.com/graphile/crystal/tree/legacy) |
| ----------------------------------------------------------------------------------------------------- |

## Project summaries

Here's a rough breakdown of the main packages:

- **[grafast][]** - standalone cutting-edge planning and execution engine for
  GraphQL; see above for full description.
  - **[@dataplan/pg][]** - plan classes for interacting with PostgreSQL
  - **[@dataplan/json][]** - plan classes for encoding/decoding JSON
- **[graphile-export][]** - a package that can (under the right circumstances)
  export an in-memory dynamically-constructed GraphQL schema to raw JavaScript
  source code that can be imported and executed
  - **[eslint-plugin-graphile-export][]** - an ESLint plugin that helps you
    write code compatible with graphile-export
- **[jest-serializer-graphql-schema][]** - a simple Jest serializer that
  understands Gr