Building Chatty — Part 1: Setup
A WhatsApp clone with React Native and Apollo
This is the first blog in a multipart series where we will be building Chatty, a WhatsApp clone, using React Native and Apollo. You can view the code for this part of the series here.
Overview
Each part of this series will be focused on teaching a core concept of Apollo or React Native. We’ll start from scratch, and by the end of the series, we’ll have a kick-ass group messaging application with real-time updates.
Steps
- Setup
- GraphQL Queries with Express
- GraphQL Queries with React Apollo
- GraphQL Mutations & Optimistic UI
- GraphQL Pagination
- GraphQL Subscriptions
- GraphQL Authentication
Future posts beyond the core series will cover more complex features like push notifications, file uploads, and query optimizations.
Since we are using shiny new tech, this series will be a living document. I will update each post as the tools we use continue to advance. My goal is to use this series as a best practices model for building a complex application using some of the best software available.
With that in mind, if you have any suggestions for making this series better, please leave your feedback!
The Stack
Chatty will use the following stack:
- Server: Apollo Server
- Client: React Native
- Middleware: Apollo (GraphQL)
- Database: SQL (sqlite to start)
This is a pretty awesome stack for building complex real-time native applications.
For those of you who are new to Apollo, I just want to point out some of the coolest built-in features for Apollo with React:
- Smart query caching (client side state gets updated and cached with each query/mutation)
- Subscriptions (realtime updates pushed by server)
- Optimistic UI (UI that predicts how the server will respond to requests)
- SSR support
- Prefetching
That’s a ton of buzzwords! In the end, what that all really adds up to is our app will be data driven, really fast for users, and get real-time updates as they happen.
Part 1 Goals
Here’s what we are going to accomplish in this first tutorial:
- Set up our dev environment
- Start an Apollo Server
- Create our first GraphQL Schema
- Start a basic React Native client
- Connect our Apollo Server and RN client!
Getting started
For this tutorial series, we’re going to start from absolute scratch. My style is to keep everything really simple and refactor as we add complexity. Let’s start with this basic directory structure:
/chatty
/node_modules
package.json
/server
... server files
/client
/node_modules
package.json
... RN filesWe will keep our React Native code separate from our server code. This will also keep server dependencies separate from React Native dependencies, which means we will have 2 package.json files. That may sound weird/bad, but trying to get everything set up with one packager is a huge hassle. It will also save us from a few other issues down the line.
Step 1.1: Create package.json and index.js
Here’s the terminal code to get us started:
# make our directory
mkdir chatty
cd chatty# start npm package managing
npm init# build some server folders and files
mkdir server
cd server
touch index.js
Setting up the dev environment
We’ll start setting up our dev env with the following features:
- Server stays running and reloads when we modify code
- ES6 syntax including import syntax in our server code
- ESLint with AirBNB presets
# from root dir..# add dev dependencies
npm i -g eslint-cli # eslint is an excellent linter# i -D is short for install --save-dev ;)
npm i -D babel-cli babel-preset-es2015 babel-preset-stage-2 nodemon eslint babel-eslint
eslint --init # choose airbnb preset or your preferred setup
My eslintrc.js file looks like this:
Step 1.2: Add eslint, babel, and nodemon
Added .eslintrc.js
...module.exports = {
"parser": "babel-eslint",
"extends": "airbnb",
"plugins": [
"react",
"jsx-a11y",
"import"
],
"rules": {
"react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }],
"react/require-default-props": [0],
"react/no-unused-prop-types": [2, {
"skipShapeProps": true
}],
"react/no-multi-comp": [0],
"no-bitwise": [0],
},
};
Create our start script inside package.json:
Step 1.3: Create start script
Changed package.json
... "repository": "https://github.com/srtucker22/chatty.git",
"author": "Simon Tucker <srtucker22@gmail.com>",
"license": "MIT",
"scripts": {
"start": "nodemon --watch server --watch package.json server/index.js --exec babel-node --presets es2015,stage-2"
},
"devDependencies": {
"babel-cli": "^6.24.1",
"babel-eslint": "^8.2.1",
Starting the Express server
Let’s import apollo-server in index.js using ES6 syntax.
npm i apollo-server graphql(apollo-serverrequiresgraphql)- Add the following to
index.js:
Step 1.4: Add ApolloServer
Changed package.json
... "eslint-plugin-jsx-a11y": "^6.0.3",
"eslint-plugin-react": "^7.5.1",
"nodemon": "^1.11.0"
},
"dependencies": {
"apollo-server": "^2.0.0",
"graphql": "^0.13.2"
}
}
Changed server/index.js
...import { ApolloServer, gql } from 'apollo-server';const PORT = 8080;// basic schema
const typeDefs = gql`
type Query {
testString: String
}
`;const server = new ApolloServer({ typeDefs, mocks: true });server.listen({ port: PORT }).then(({ url }) => console.log(`🚀 Server ready at ${url}`));
Quickly verify our setup works by running npm start: 🚀 Server ready at http://localhost:8080/
We have a great starting point. Our start script will transpile ES6 code, spin up our Apollo Server, and refresh as we make changes to server code. Nice!
But wait, there’s more! Apollo Server comes with some amazing features out of the gate, including GraphQL Playground. Head on over to http://localhost:8080/ and you should see a slick playground for us to test GraphQL queries against our server!
Type in {testString} and you should get back a response:
Great! So now we have a server that runs the most basic GraphQL. We could build up our GraphQL backend a bit more, but I’d prefer to connect our server and React Native client before we make our Schema any more complex.
Starting the React Native client
First we’ll download the dependencies and initialize our React Native app. For the sake of brevity, I’m going to focus on iOS, but all our code should also work with Android.
# you'll need to also install XCode for iOS development
# double check these setup instructions at https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies
brew install node
brew install watchman# from root dir...
npm i -g react-native-cli# initialize RN with name chatty
react-native init chatty# --- from here on out we'll be doing our own thing ---# change name of RN folder to client
mv chatty client# run the app in simulator
cd client
react-native run-ios # and grab a snack or something cause this might take a while the first run...
Running the initialization will create an index.js file. In this file is boilerplate code that creates a React component and registers it with AppRegistry, which renders the component.
Let’s pull out the Chatty component from index.js and stick it in its own file. I prefer to organize my files by type rather than feature, but you’re welcome to organize differently if you feel strongly about it.
So I’m going to place the Chatty component code into client/src/app.js and rename the component App.
Step 1.6: Move app code to /src
Changed client/index.js
.../** @format */import {AppRegistry} from 'react-native';
import App from './src/app';
import {name as appName} from './app.json';AppRegistry.registerComponent(appName, () => App);
Changed client/App.js
... 'Shake or press menu button for dev menu',
});export default class App extends Component {
render() {
return (
<View style={styles.container}>
Adding Apollo to React Native
We’re going to modify app.js to use React-Apollo and Redux. While Apollo can be used sans Redux, the developer experience for React Native is much sweeter with Redux for monitoring our app's state, as you'll soon see.
We need to add a bunch of Apollo packages and a couple Redux ones:
# **make sure we're adding all react native and client related packages to package.json in the client folder!!!**
cd clientnpm i apollo-cache-redux apollo-client apollo-link apollo-link-error apollo-link-http apollo-link-redux graphql graphql-tag react-apollo react-redux redux redux-devtools-extension
We need to do the following:
- Create a Redux store
- Create an Apollo client
- Connect our Apollo client to our GraphQL endpoint via
apollo-link-http - Catch and log any GraphQL errors via
apollo-link-error - Connect Redux to our Apollo workflow via
apollo-link-redux. This will let us track Apollo events as Redux actions! - Set our Apollo client’s data store (cache) to Redux via
apollo-cache-redux
We can also swap out compose for composeWithDevTools, which will let us observe our Redux state remotely via React Native Debugger.
Step 1.7: Add ApolloClient
Changed client/package.json
...{
"name": "chatty",
"version": "0.0.1",
"private": true,
"scripts": {
"start": "node node_modules/react-native/local-cli/cli.js start",
"test": "jest"
},
"dependencies": {
"apollo-cache-redux": "^0.1.0-alpha.7",
"apollo-client": "^2.2.5",
"apollo-link": "^1.1.0",
"apollo-link-error": "^1.0.7",
"apollo-link-http": "^1.3.3",
"apollo-link-redux": "^0.2.1",
"graphql": "^0.12.3",
"graphql-tag": "^2.4.2",
"react": "16.4.1",
"react-apollo": "^2.0.4",
"react-native": "0.56.0",
"react-redux": "^5.0.5",
"redux": "^3.7.2",
"redux-devtools-extension": "^2.13.2"
},
"devDependencies": {
"babel-jest": "23.4.0",
"babel-preset-react-native": "^5",
"jest": "23.4.1",
"react-test-renderer": "16.4.1"
},
"jest": {
"preset": "react-native"
}
}
Changed client/src/app.js
...import React, { Component } from 'react';
import {
Platform,
StyleSheet,
Text,
View,
} from 'react-native';import { ApolloClient } from 'apollo-client';
import { ApolloLink } from 'apollo-link';
import { ApolloProvider } from 'react-apollo';
import { composeWithDevTools } from 'redux-devtools-extension';
import { createHttpLink } from 'apollo-link-http';
import { createStore, combineReducers } from 'redux';
import { Provider } from 'react-redux';
import { ReduxCache, apolloReducer } from 'apollo-cache-redux';
import ReduxLink from 'apollo-link-redux';
import { onError } from 'apollo-link-error';const URL = 'localhost:8080'; // set your comp's url hereconst store = createStore(
combineReducers({
apollo: apolloReducer,
}),
{}, // initial state
composeWithDevTools(),
);const cache = new ReduxCache({ store });const reduxLink = new ReduxLink(store);const errorLink = onError((errors) => {
console.log(errors);
});const httpLink = createHttpLink({ uri: `http://${URL}` });const link = ApolloLink.from([
reduxLink,
errorLink,
httpLink,
]);export const client = new ApolloClient({
link,
cache,
});const instructions = Platform.select({
ios: 'Press Cmd+R to reload,\n' + 'Cmd+D or shake for dev menu',
Finally, we need to connect our app to Apollo and Redux. We’ll wrap our App component in the ApolloProvider component from react-apollo and the Provider component from redux.
Step 1.8: Add ApolloProvider to App
Changed client/src/app.js
...export default class App extends Component {
render() {
return (
<ApolloProvider client={client}>
<Provider store={store}>
<View style={styles.container}>
<Text style={styles.welcome}>Welcome to React Native!</Text>
<Text style={styles.instructions}>To get started, edit App.js</Text>
<Text style={styles.instructions}>{instructions}</Text>
</View>
</Provider>
</ApolloProvider>
);
}
}
If we reload the app (CMD + R), there hopefully should be no errors in the simulator. We can check if everything is hooked up properly by opening Redux Native Debugger and confirming the Redux store includes apollo:
Hello world!
You have successfully created a solid setup for a full-stack Apollo app with Express and React Native. In the next step, we are going to expand our GraphQL Schema, add Queries, and connect real data from a database.
As always, please share your thoughts, questions, struggles, and breakthroughs below!
