Following the GraphQL Apollo Starter Kit (Lerna, Node.js), I wanted to dig deeper into developing a monorepo for a GraphQL/React client-server application.
Unfortunately, things are not as easy as I thought at first. Chiefly the create-react-app template does not appear to work very well with monorepos and local dependencies to other packages.
That’s why I put together a small, simple starter template for developing modular client-server applications using React, GraphQL and Node.js. Here is the code on GitHub:
Some things to note:
- There are four packages in the project
- client-main: The React client, based on create-react-app
- client-components: Contains a definition of the component app. Used by client-main
- server-main: The Node.js server definition
- server-books: Contains schema and resolver for GraphQL backend. Used by server-main.
- Each package defines it’s own
package.json and can be built independent of the other packages.
- The main entry point for the dependent packages (client-components and server-books) is set to
dist/index.js. This way, packages which use them, can use the transpiled version created by babel and don’t need to worry about specific JS features used in the dependent packages.
Like GraphQL Apollo Starter Kit (Lerna, Node.js) this starter kit is meant to be very basic to allow easy exploration of the source code.
In many ways developing in Node.js is very fast and lightweight. However it can also be bewildering at times. Mostly so since for everything there seems to be more than one established way of doing things. Moreover, the right way to do something can change within 3 to 6 months, so best practices documented in books and blogs quickly become obsolete.
Some days ago I wanted to create a simple sample project that shows how to develop a simple client/server application using Apollo and React. I thought this would be a simple undertaking. I imagined I would begin with a simple tutorial or ‘starter kit’ and quickly be up and running.
I found that things were not as easy as I imagined, since there are plenty of examples to spin up a simple react app chiefly using create-react-app. I also found the awesome apollo-universal-starter-kit. However, the former lacks insight of how to link this to a Node.js back-end server and the latter is a bit complex and opinionated in some ways as to which frameworks to use.
This motivated me to develop a small, simple ‘starter kit’ for Apollo Client and Server in GraphQL with the following features:
- Uses Lerna to define project with two packages (client and server)
- Uses Node.js / Express as web server
- Uses Babel to allow using ES 6 style modules for Node.js
- Provides easy ways to start a development server and spin up a production instance
Here a link to the project on GitHub:
The README provides the instructions to run and build the project.
A few things of note about the implementation:
This project is aimed at developers new to Node.js/React/Apollo. It is not implemented in the most elegant way possible but in a way which makes it easy to understand what is going on by browsing through the code. Be welcome to check out the project and modify it!