Boilerplate for an Advanced GraphQL Server w/ TypeScript and Prisma and Graphqlgen

🚀 Bootstrap your GraphQL server within seconds

Advanced starter kit for a flexible GraphQL server for TypeScript and Prisma - based on best practices from the GraphQL community.

Features

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

Getting started

# 1. Clone the repository from Github
git clone

# 2. Navigate to the new project
cd node-graphql-ts-prisma

# 3. Install dependencies with yarn or npm
yarn or npm install

# 4. If you have a prisma url, update prisma/prisma.yml:endpoint with your custom endpoint

# 5. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn start

Documentation

Commands

yarn start starts GraphQL server on http://localhost:4000
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
`├── .graphqlgen.yml`	Configuration file based on `graphqlgen` (Generate & scaffold type-safe resolvers based on your GraphQL Schema in TypeScript).
`└── 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
`├── types.ts`	The domain model types
`├── 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-client` (directory)	The generated Prisma client

Contributing

Your feedback is very helpful, please share your opinion and thoughts! If you have any questions or want to contribute yourself, feel free to contact me or submit a PR.

aircliff01 / node-graphql-ts-prisma

readme