Skip to content
Branch: master
Find file History

README.md

Boilerplate for a Minimal GraphQL Server w/ TypeScript


🚀 Bootstrap your GraphQL server within seconds
Minimal starter kit for a flexible GraphQL server for TypeScript - based on best practices from the GraphQL community.

Features

  • Scalable GraphQL server: The server uses graphql-yoga which is based on Apollo Server & Express
  • Tooling: Out-of-the-box support for GraphQL Playground & query performance tracing
  • Simple Hello World example: Where it either returns Hello <name>! or Hello World! if no name argument is provided.
  • No configuration overhead: Preconfigured graphql-config setup

Read more about the idea behind GraphQL boilerplates here.

Requirements

You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql create:

npm install -g graphql-cli

Getting started

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

# 2. Run yarn install or npm install

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

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

Documentation

Commands

  • yarn start or npm run start starts GraphQL server on http://localhost:4000
  • yarn dev or npm run dev starts GraphQL server on http://localhost:4000 and opens GraphQL Playground

Project structure

File name                Description         

└── src (directory) Contains the source files for your GraphQL server
  ├── index.ts The entry point for your GraphQL server

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.

You can’t perform that action at this time.