Boilerplate for a Basic GraphQL Server w/ TypeScript
- Scalable GraphQL server: The server uses
graphql-yogawhich is based on Apollo Server & Express
- Static type generation: TypeScript types for GraphQL queries & mutations are generated in a build step
- 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
Read more about the idea behind GraphQL boilerplates here.
You need to have the GraphQL CLI installed to bootstrap your GraphQL server using
npm install -g graphql-cli
# 1. Bootstrap GraphQL server in directory `my-app`, based on `typescript-basic` boilerplate graphql create my-app --boilerplate typescript-basic # 2. When prompted, deploy the Prisma service to a _public cluster_ # 3. Navigate to the new project cd my-app # 4. Start server (runs on http://localhost:4000) and open GraphQL Playground yarn dev
yarn startstarts GraphQL server on
yarn devstarts GraphQL server on
http://localhost:4000and opens GraphQL Playground
yarn playgroundopens the GraphQL Playground for the
yarn prisma <subcommand>gives access to local version of Prisma CLI (e.g.
yarn prisma deploy)
Note: We recommend that you're using
yarn devduring 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.
||Contains all files that are related to the Prisma database service|
||The root configuration file for your Prisma database service (docs)|
||Defines your data model (written in GraphQL SDL)|
||Contains the source files for your GraphQL server|
||The entry point for your GraphQL server|
||The application schema defining the API exposed to client applications|
||Contains generated files|
||The generated Prisma client|
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.