Boilerplate for a Basic GraphQL Server

🚀 Bootstrap your GraphQL server within seconds

Basic starter kit for a flexible GraphQL server for Node.js - based on best practices from the GraphQL community.

Features

• Scalable GraphQL server: The server uses apollo-server v2 which is based on new Apollo Server
• GraphQL database: Includes GraphQL database binding to Prisma (running on MySQL)
• Tooling: Out-of-the-box support for GraphQL Playground & query performance tracing
• Extensible: Simple and flexible data model – easy to adjust and extend
• No configuration overhead: Preconfigured graphql-config setup

For a fully-fledged GraphQL & Node.js tutorial, visit How to GraphQL. You can more learn about the idea behind GraphQL boilerplates here.

Requirements

You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql init, Prisma to deploy and update database use prisma deploy and Yarn to install npm packages:

npm install -g graphql-cli prisma yarn

Getting started

# 1. Clone the project
git clone https://github.com/danilobrinu/prisma-apollo-starter.git

# 2. Navigate to the new project
cd prisma-apollo-starter

# 3. Install npm packages
yarn install

# 4. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn dev

Note: Create new enviroment using example.env and update __PRISMA_ENDPOINT__ if you don't have prisma endpoint run prisma deploy and use Demo Server to get prisma endpoint

Documentation

Commands

• yarn start starts GraphQL server on http://localhost:4000
• yarn debug starts GraphQL server in debug mode on http://localhost:4000
• yarn playground opens the GraphQL Playground for the projects from .graphqlconfig.yml
• yarn dev starts GraphQL server on http://localhost:4000 and opens GraphQL Playground
• prisma <subcommand> gives access to local version of Prisma CLI (e.g. prisma deploy)

Note: We recommend that you're using yarn dev during development as it will give you access to the GraphQL API or your server (defined by the application schema) as well as to the Prisma API directly (defined by the Prisma database schema). If you're starting the server with yarn start, you'll only be able to access the API of the application schema.

Project structure

File name	Description
├── example.env	Use this file to configure your enviroment (copy/paste or rename to .env)
├── .graphqlconfig.yml	Configuration file based on graphql-config (e.g. used by GraphQL Playground).
└── database/	Contains all files that are related to the Prisma database service
├── prisma.yml	The root configuration file for your Prisma database service (docs)
└── enums.graphql	Defines your enums for data model (written in GraphQL SDL)
└── seed.graphql	Defines your seed data model (written in GraphQL SDL)
└── types.graphql	Defines your types for data model (written in GraphQL SDL)
└── src/	Contains the source files for your GraphQL server
├── index.js	The entry point for your GraphQL server
├── schema.graphql	The application schema defining the API exposed to client applications
├── resolvers/	Contains the implementation of the resolvers for the application schema
└── generated/	Contains generated files
└── prisma.grapghql	The Prisma database schema defining the Prisma GraphQL API

Contributing

The GraphQL boilerplates are maintained by the GraphQL community, with official support from the Apollo & Graphcool teams.

Your feedback is very helpful, please share your opinion and thoughts! If you have any questions or want to contribute yourself, join the #graphql-boilerplate channel on our Slack.