- Scalable GraphQL server: The server uses
graphql-yoga
which is based on Apollo Server & Express - Pre-configured Apollo Client: The project comes with a preconfigured setup for Apollo Client
- 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
For a fully-fledged React & Apollo tutorial, visit How to GraphQL. You can more learn about the idea behind GraphQL boilerplates here.
You need to have the GIT installed to clone down the Repository
Before you can get started with this boilerplate there are some initial configurations that need to occur. These configurations involve deploying to a Prisma endpoint and setting up environment variables. In this example, we will be using a Prisma demo server and thus will require a Prisma account.
# 1. Clone the Repo from GitHub
- optionally rename the cloned Repo by providing a project name
git clone https://github.com/wes-cutting/graphql-prisma-boilerplate <project-name>
# 2. Navigate into the `server` directory of the new project
cd <project-name>/server
# 3. Create an environment variable file
touch .env
# 4. Open your desired text editor and add in the falling values to .env file
# 5. Open a new tab in the terminal and navigate back into my-app;
# then run the app
cd ..
yarn start
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 |
---|---|
βββ .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.js |
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.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.