- Scalable GraphQL server: The server uses
graphql-yogawhich is based on Apollo Server & Express - 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-configsetup
For a fully-fledged GraphQL & Node.js tutorial, visit How to GraphQL. You can more learn about the idea behind GraphQL boilerplates here.
You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql init and Prisma to deploy and update database using prisma deploy:
npm install -g graphql-cli prisma yarn
# 1. Clone the project git clone https://github.com/danilobrinu/prisma-starter-kit.git # 2. Navigate to the new project cd prisma-starter-kit # 3. Install npm packages yarn install # 3. 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
Note: We recommend not update graphql-yoga for now, have some issues leave the stable version graphql-yoga@1.12.1 for now.
yarn startstarts GraphQL server onhttp://localhost:4000yarn debugstarts GraphQL server in debug mode onhttp://localhost:4000yarn playgroundopens the GraphQL Playground for theprojectsfrom.graphqlconfig.ymlyarn devstarts GraphQL server onhttp://localhost:4000and opens GraphQL Playgroundprisma <subcommand>gives access to local version of Prisma CLI (e.g.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 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/ |
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 |
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.