New to the project?

MAC

• Install Docker for Mac
• Install prisma with npm i -g prisma
• Run npm install
• Run prisma deploy and choose local (Make sure you have docker installed before this step!!)
• Run yarn dev (or npm start ) to deploy the server locally
• yarn dev will open an in browser graphql playground where if you prefer graphiql desktop version you can use that instead
• to open a mysql terminal to inspect the database run docker exec -it prisma-db mysql -u root --host 127.0.0.1 --port 3306 --password=graphcool

UBUNTU

• Install Docker for Ubuntu
• Ensure that node is at least version 9 by running node --version (install node 9)
• Install prisma with sudo npm i -g prisma
• May need to install [email protected] with npm install [email protected]
• May need to install [email protected] with npm install [email protected]
• Run npm install
• Run prisma deploy and choose local (Make sure you have docker installed before this step!!)
• Run npm start to deploy the server locally

Advanced GraphQL Node Server

Features

• Scalable GraphQL server: The server uses graphql-yoga which is based on Apollo Server & Express
• GraphQL database: Includes GraphQL database binding to Prisma (running on MySQL)
• Authentication: Signup and login workflows are ready to use for your users
• 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 (coming soon)

For a fully-fledged GraphQL & Node.js tutorial, visit How to GraphQL. You can more learn about the idea behind GraphQL boilerplates here.

Documentation

Commands

• yarn start starts GraphQL server on http://localhost:4000
• yarn dev starts GraphQL server on http://localhost:4000 and opens GraphQL Playground
• yarn playground opens the GraphQL Playground for the projects 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 with yarn start, you'll only be able to access the API of the application schema.

Project structure

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.js	The entry point for your GraphQL server
├── schema.graphql	The application schema defining the API exposed to client applications
├── resolvers (directory)	Contains the implementation of the resolvers for the application schema
└── generated (directory)	Contains generated files
└── prisma.grapghql	The Prisma database schema defining the Prisma GraphQL API