typescript-basic

🚀 Basic starter code for a scalable, production-ready GraphQL server written in TypeScript.

Features

• Scalable GraphQL Server: graphql-yoga based on Apollo Server & Express
• GraphQL-native database: Includes GraphQL database binding to Prisma (running on MySQL)
• Out-of-the-box support for GraphQL Playground & Tracing
• Simple data model – easy to adjust
• Preconfigured graphql-config setup

Requirements

You need to have the following things installed:

• Node 8+ & TypeScript
• GraphQL CLI: npm i -g graphql-cli

Getting started

# 1. Bootstrap GraphQL server in directory `my-app`, based on `typescript-basic` boilerplate
graphql create my-app --boilerplate typescript-basic

# 2. When prompted, choose the Prisma cluster you want to deploy to
# e.g. prisma-eu1 or prisma-us1 to deploy to a public cluster (recommended)
# or locally (requires Docker)

# 3. Navigate to the new project
cd my-app

# 4. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn dev
# or
# yarn start # (only starts the server, no access to the Prisma API)

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 schema). If you're starting the server with yarn start, you'll only be able to access the API for the application schema.

Docs

Commands

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

Project structure

/ - configuration files

• .env Contains important environment variables for development. Read about how it works here.
• .graphqlconfig.yml GraphQL configuration file containing the endpoints and schema configuration. Used by the graphql-cli and the GraphQL Playground. See graphql-config for more information.

/database - Prisma service

• database/prisma.yml The configuration file for your database service (documentation).
• database/datamodel.graphql contains the data model that you define for your database service (written in SDL).

/src - application server

• src/schema.graphql defines your application schema. It contains the GraphQL API that you want to expose to your client applications.
• src/index.js is the entry point of your server, putting everything together and starting the GraphQLServer from graphql-yoga.
• src/resolvers/ contains the actual business logic of your application. In GraphQL, you implement resolver functions that resolve a specific query being requested.
• src/generated/prisma.graphql defines the database schema. It contains the GraphQL API exposed by the Prisma Database. This file is automatically generated every time yarn prisma deploy is executed, according to the datamodel in database/datamodel.graphql.
• src/generated/prisma.ts contains the generated TypeScript type definitions from the prisma-binding. You can read more about static bindings in this article.

Contributing

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