- Scalable GraphQL server: The server uses
graphql-yoga
which is based on Apollo Server & Express - Static type generation: TypeScript types for GraphQL queries & mutations are generated in a build step
- Authentication: Signup and login workflows are ready to use for your users
- 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 - Realtime updates: Support for GraphQL subscriptions
Read more about the idea behind GraphQL boilerplates here.
You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql create
:
npm install -g graphql-cli
# 1. Bootstrap GraphQL server in directory `my-app`, based on `typescript-advanced` boilerplate
graphql create my-app --boilerplate typescript-advanced
# 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 start
starts GraphQL server onhttp://localhost:4000
yarn dev
starts GraphQL server onhttp://localhost:4000
and opens GraphQL Playgroundyarn playground
opens the GraphQL Playground for theprojects
from.graphqlconfig.yml
yarn prisma <subcommand>
gives access to local version of Prisma CLI (e.g.yarn 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 withyarn start
, you'll only be able to access the API of the application schema.
File name ใใใใใใใใใใใใใใ | Description ใใใใใใใใ |
---|---|
โโโ .env |
Defines environment variables |
โโโ .graphqlconfig.yml |
Configuration file based on graphql-config (e.g. used by GraphQL Playground). |
โโโ database (directory) |
Contains all files that are related to the Prisma database service |
ใใโโโ prisma.yml |
The root configuration file for your Prisma database service (docs) |
ใใโโโ datamodel.graphql |
Defines your data model (written in GraphQL SDL) |
โโโ src (directory) |
Contains the source files for your GraphQL server |
ใใโโโ index.ts |
The entry point for your GraphQL server |
ใใโโโ schema.graphql |
The application schema defining the API exposed to client applications |
ใใโโโ generated (directory) |
Contains generated files |
ใใใใโโโ prisma.ts |
The generated TypeScript bindings for the Prisma GraphQL API |
ใใใใโโโ prisma.grapghql |
The Prisma database schema defining the Prisma GraphQL API |
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.