Added Travis CI and added flow implementation to tutorial (#7)

* Added flow implementation to the tutorial
* Added Travis CI integration
* Added Travis CI support
* Removed the ‘|| exit 0’ from the test and check script so that it correctly works with Travis CI
* Fixed typo in mochaSetup in package.json
* Added babel-polyfill to make project work with node.js 4
* Updated license tag in package.json
* Update copyright notice at the top of files
* Update the author field
* Added the Travis CI Build status to the README

Author: excitement-engineer

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+
+node_js:
+  - "6"
+  - "5"
+  - "4"
+
+script: npm run travis

README.md

@@ -1,5 +1,7 @@
 # Example Node server with a GraphQL API
 
+[![Build Status](https://travis-ci.org/HiThereCommunity/example-graphql-server.svg?branch=master)](https://travis-ci.org/HiThereCommunity/example-graphql-server)
+
 This repository contains an example of a [Node.js](https://nodejs.org/en/) server
 that exposes a [GraphQL](http://graphql.org/) API.
 

docs/tutorial.md

@@ -2,14 +2,16 @@
 
 So you want to implement a [graphQL](http://graphql.org/) api on node.js but are unsure where to begin? Then keep reading:) 
 
+In this document I want to share what I have learned about setting up a node.js project that contains a graphQL API. 
+
 In this tutorial I want to share what I have learned about setting up a node.js project that contains a graphQL API. 
 
 More specifically, I want to explain how to: 
 
 - Set up a simple `Hello, world` graphQL API in node.js
 - Create a workflow for developing, testing and deploying your node.js codebase. 
 
-This turorial is based on a node.js GraphQL starter project on [Github](https://github.com/HiThereCommunity/example-graphql-server).
+> Note, this tutorial is based on the source code in this repository but does not follow it completely...
 
 I have used this starter project several times and it has allowed me to develop an API relatively quickly. In addition, the workflow has lowered my development time and increased the stability of my codebase.
 
@@ -201,7 +203,7 @@ For more information on how to use `graphql-js` to build up a schema, I urge you
 
 The final step is to link the schema (in `src/GraphQL/index.js`) to an endpoint.
 
-Open `src/index.js` and import the schema from `./GraphQl`. Next, we will make the schema available using `express-graphql` under the path `/`. Make sure to set the option `graphiql` to yes. This will allow us to play with our graphQL schema using [graphiQL](https://github.com/graphql/graphiql)
+Open `src/index.js` and import the schema from `./GraphQL`. Next, we will make the schema available using `express-graphql` under the path `/`. Make sure to set the option `graphiql` to yes. This will allow us to play with our graphQL schema using [graphiQL](https://github.com/graphql/graphiql)
 
 ```js
 import express from 'express';
@@ -282,7 +284,7 @@ Like the previous sections we will again write a npm script to run all our tests
 ```diff
   "scripts": {
     "start": "nodemon src/index.js --exec babel-node",
-+	"test": "mocha --require resources/MochaSetup src/**/__tests__/**/*.js || exit 0"
++	"test": "mocha --require resources/mochaSetup src/**/__tests__/**/*.js"
    }
 ```
 
@@ -346,6 +348,87 @@ This should output a message indicating that the test has passed.
 
 This testing workflow makes it really easy to write tests for your node.js code (and by extension your graphQL layer). As you extend your GraphQL layer you can create new test files or extend `testHello` with additional tests to make sure that your code is functioning as expected.
 
+## Add [flow](https://flowtype.org/) to project
+
+[Flow](https://flowtype.org/) is a static type checker for javascript that helps in finding bugs without actually running your code. This is very useful and helps tremendously in writing stable code.
+
+Implementing Flow is easy! All we have to do is install it as a dependency:
+
+```
+$ npm install --save-dev flow-bin
+```
+
+In Flow you can add [type annotations](https://flowtype.org/docs/type-annotations.html#_) to your javascript to add type safety to the code, however this is not standard javascript so we need to tell babel to automatically remove these types. This is done by adding a babel plugin: 
+
+```
+$ npm install --save-dev babel-plugin-transform-flow-strip-types
+```
+
+Next, update the `.babelrc` with the plugin
+
+```diff
+{
+  "presets": ["es2015", "stage-2"],
++ "plugins": ["transform-flow-strip-types"]
+}
+```
+
+The next step is to create a simple script for performing the flow check. Add the following script to the `package.json` file: 
+
+```diff
+  "scripts": {
+    "start": "nodemon src/index.js --exec babel-node",
+	"test": "mocha --require resources/mochaSetup src/**/__tests__/**/*.js",
++	"check": "flow check"
+   }
+```
+
+Finally, we need to add a `.flowconfig` file that contains the [configurations](https://flowtype.org/docs/advanced-configuration.html). This file can be generated by running the command:
+
+```
+$ flow init
+```
+
+A `.flowconfig` should appear at the root of your project.
+
+We have now successfully implemented Flow into the project and we can begin using it. Make sure to add `// @flow` to the top of any file that we want to be checked with Flow.
+
+Let's add a type annotation to our GraphQL schema in `src/graphQL/index.js`. In the code below we have added `// @flow` to the top of the file and added the type annotation `?string` to the resolve function of the `hello` query indicating that this resolve function should return a string or null.
+
+```js
+// @flow
+
+import {
+    GraphQLString,
+    GraphQLObjectType,
+    GraphQLSchema,
+} from 'graphql';
+
+export default new GraphQLSchema({
+    query: new GraphQLObjectType({
+        name: 'Queries',
+        description: "All the queries that can be used to retrieve data",
+        fields: () => ({
+            hello: {
+                type: GraphQLString,
+                description: "Hello, world",
+                resolve: (): ?string => "hello, world"
+            }
+        })
+    })
+});
+```
+
+Run the flow check command
+
+```
+$ npm run check
+```
+
+Flow will check your file for any type errors. Flow should indicate that it has not found any type errors: `Found 0 errors`.
+
+Simply add `// @flow` to any other files that you wish to be checked by flow.
+
 # Deploying to production
 
 In the development workflow we use `babel-node` for compiling javascript and starting the server. However, Babel explicitly [states](https://babeljs.io/docs/usage/cli/) that this should not be used for running node.js because it is very heavy to run and will add unnecessary overhead to the server.
@@ -363,7 +446,8 @@ For this we will write a new `build` script in the `package.json` file:
 ```diff
   "scripts": {
     "start": "nodemon src/index.js --exec babel-node",
-    "test": "mocha --require resources/MochaSetup src/**/__tests__/**/*.js || exit 0"
+    "test": "mocha --require resources/mochaSetup src/**/__tests__/**/*.js",
+    "check": "flow check",
 +   "build": "babel src --ignore __tests__ --out-dir dist/"
    }
 ```
@@ -383,7 +467,8 @@ Finally, we need to start the compiled production server code. For this we will
 ```diff
   "scripts": {
     "start": "nodemon src/index.js --exec babel-node",
-    "test": "mocha --require resources/MochaSetup src/**/__tests__/**/*.js || exit 0"
+    "test": "mocha --require resources/mochaSetup src/**/__tests__/**/*.js",
+    "check": "flow check",
     "build": "babel src --out-dir dist/",
 +   "serve": "babel src --ignore __tests__ --out-dir dist/"
    }

package.json

@@ -7,8 +7,9 @@
     "start": "nodemon src/index.js --exec babel-node",
     "build": "babel src --ignore __tests__ --out-dir dist/",
     "serve": "node dist/index.js",
-    "test": "mocha --require resources/MochaSetup src/**/__tests__/**/*.js || exit 0",
-    "check": "flow check || exit 0"
+    "test": "mocha --require resources/mochaSetup src/**/__tests__/**/*.js",
+    "check": "flow check",
+    "travis": "npm run check && npm run test"
   },
   "engines": {
     "node": ">=5.3.0",
@@ -24,11 +25,8 @@
     "API",
     "node.js"
   ],
-  "contributors": [
-    "Dirk-Jan Rutten <dirk-jan.rutten@hi-there.community>",
-    "Florentijn Hogerwerf <florentijn.hogerwerf@hi-there.community>"
-  ],
-  "license": "ISC",
+  "author": "Dirk-Jan Rutten <dirkjanrutten@gmail.com>",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/HiThereCommunity/example-graphql-server/issues"
   },

resources/mochaSetup.js

@@ -1,5 +1,10 @@
 /**
- * Created by dirk-janrutten on 18/06/16.
+ * Copyright (c) 2016, Dirk-Jan Rutten
+ * All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
  */
 
 /** Required for transpiling Mocha test code using babel **/

src/graphQL/__tests__/test.js

@@ -1,5 +1,10 @@
 /**
- * Created by Dirk-Jan Rutten on 18/06/16.
+ * Copyright (c) 2016, Dirk-Jan Rutten
+ * All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
  */
 
 import {

src/graphQL/index.js

@@ -1,7 +1,11 @@
 // @flow
-
 /**
- * Created by Dirk-Jan Rutten on 18/06/16.
+ * Copyright (c) 2016, Dirk-Jan Rutten
+ * All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
  */
 
 import {
@@ -18,7 +22,7 @@ export default new GraphQLSchema({
             hello: {
                 type: GraphQLString,
                 description: "Hello, world",
-                resolve: () => "hello, world"
+                resolve: (): ?string => "hello, world"
             }
         })
     })

src/index.js

@@ -1,5 +1,12 @@
 // @flow
-"use strict";
+/**
+ * Copyright (c) 2016, Dirk-Jan Rutten
+ * All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
 
 import "babel-polyfill";