graphql-server-typed

Boilerplate project for create-graphql-app cli.

Create a fully configured, production ready graphql server, using

• typescript
• graphql-code-generator
• graphql-subscriptions
• merge-graphql-schemas
• Dependency injection with injection-js

This project demonstrates how to generate typescript types from graphql schema, using Graphql code generetor library.

Installation

Clone the repository and run npm install

git clone https://github.com/tomyitav/graphql-server-typed.git
npm install

Build and start server instance

Build command

Running the command

npm run build

Or on windows machine, run

npm run build:win

will generate typescript types, and transpile code to dist folder

How to start server instance after building

npm start

Run server directly with ts-node

npm start:dev

Watch for code changes

npm run start:watch

This will monitor your changes and will automatically restart the server.

The server will run on port 8080. You can change this by editing the config file.

Code Formatting

We use Prettier and Tslint to format and enforce standards on our code.
Both will run on the project automatically before each commit.

Prettier rewrites code according to the .prettierrc.json configuration file.
If you want to activate prettier manually (on all .ts files inside src folder) without committing, run:

npm run prettier

Tslint will check rules found in the tslint.json configuration file.
If you want to check tslint manually (on all .ts files inside src folder) without committing, run:

npm run tslint

Type generation using gql codegen

npm run generate

This will automatically generate types in types.d.ts file! generate command is executed in every build

Project structure

We use the function makeExecutableSchema() from graphql-tools to to combine our types and resolvers. Instead of passing one large string for our schema, we split our types and resolvers to multiple files, located in graphql directory in types and resolvers directories. This way, we avoid schema complexity by using merge-graphql-schemas:

  import * as path from "path";
  import {makeExecutableSchema} from "graphql-tools";
  import {fileLoader, mergeTypes, mergeResolvers} from "merge-graphql-schemas";
  import {GraphQLSchema} from "graphql";

  const typesArray = fileLoader(path.join(__dirname, '../types'), { recursive: true });
  const resolversArray = fileLoader(path.join(__dirname, '../resolvers'));
  const allTypes = mergeTypes(typesArray);
  const allResolvers = mergeResolvers(resolversArray);
  let schema: GraphQLSchema;
  schema= makeExecutableSchema({
      typeDefs: allTypes,
      resolvers: allResolvers
  });

  export default schema;

So as your project grows - you can extend the schema by adding new type in types directory, and adding matching resolver file in resolvers directory. The schema is updated automatically.

Deploy server to production 🚀

First, make sure you have now-cli installed. Then, execute the following command:

npm run deploy

That's it! The server will be deployed on now

Run server as AWS lambda

See the following project for setting up aws lambda integration

Connect to the server from client app

See the following example on how to connect to the server using apollo-angular.