🚀 A fully-featured, production ready caching GraphQL client for every UI framework and GraphQL server
TypeScript Other
Clone or download
Permalink
Failed to load latest commit information.
.circleci Disable link checker during CI Jun 6, 2018
.github docs: Update blog URLs to reference blog.apollographql.com. (#3685) Jul 13, 2018
.vscode [#3030] Fix no-cache fetchPolicy returns null or undefined (#3102) Mar 23, 2018
docs docs: Update blog URLs to reference blog.apollographql.com. (#3685) Jul 13, 2018
packages chore(deps): update dependency rxjs to v6.2.2 Jul 15, 2018
.gitignore fix(updateQuery): fix update query by passing combinedQuery variables… May 23, 2018
.npmignore Make everything ready to npm publish Jan 4, 2017
.prettierignore Disable `prettier` on `.json` files and restore formatting May 17, 2018
CHANGELOG.md Changelog updates Jul 10, 2018
CONTRIBUTING.md Fix broken link in CONTRIBUTING.md Dec 22, 2017
DESIGNS.md update errors design based on feedback Nov 29, 2016
ISSUE_TRIAGE.md Remove `blocking` label May 11, 2018
IssueTriageFlow.png add issue triage guide Mar 16, 2017
LICENSE working deploy scripts Sep 12, 2017
README.md Fixe Vanilla JS link in README Jun 11, 2018
Upgrade.md Expose `restore`, `extract` from underline cache to ApolloClient (#2615) Nov 29, 2017
appveyor.yml chore: add Node.js 10 May 5, 2018
codecov.yml Update codecov.yml Mar 25, 2018
dangerfile.ts Merge branch 'master' into evans/broken-links Jun 5, 2018
lerna.json Lerna (#1984) Aug 3, 2017
package.json chore(deps): update dependency codecov to v3.0.4 Jul 13, 2018
renovate.json Add hwillson to renovate assignees/reviewers May 18, 2018
rollup.config.js source map for rollup (#3042) Mar 14, 2018
tsconfig.base.json Set removeComments to false in tsconfig (#3086) Mar 23, 2018
tsconfig.json Set removeComments to false in tsconfig (#3086) Mar 23, 2018

README.md

Apollo Client npm version Get on Slack Open Source Helpers

Apollo Client is a fully-featured caching GraphQL client with integrations for React, Angular, and more. It allows you to easily build UI components that fetch data via GraphQL. To get the most value out of apollo-client, you should use it with one of its view layer integrations.

To get started with the React integration, go to our React Apollo documentation website.

Apollo Client also has view layer integrations for all the popular frontend frameworks. For the best experience, make sure to use the view integration layer for your frontend framework of choice.

Apollo Client can be used in any JavaScript frontend where you want to use data from a GraphQL server. It's:

  1. Incrementally adoptable, so that you can drop it into an existing JavaScript app and start using GraphQL for just part of your UI.
  2. Universally compatible, so that Apollo works with any build setup, any GraphQL server, and any GraphQL schema.
  3. Simple to get started with, so you can start loading data right away and learn about advanced features later.
  4. Inspectable and understandable, so that you can have great developer tools to understand exactly what is happening in your app.
  5. Built for interactive apps, so your users can make changes and see them reflected in the UI immediately.
  6. Small and flexible, so you don't get stuff you don't need. The core is under 25kb compressed.
  7. Community driven, because Apollo is driven by the community and serves a variety of use cases. Everything is planned and developed in the open.

Get started on the home page, which has great examples for a variety of frameworks.

Installation

# installing the preset package
npm install apollo-boost graphql-tag graphql --save
# installing each piece independently
npm install apollo-client apollo-cache-inmemory apollo-link-http graphql-tag graphql --save

To use this client in a web browser or mobile app, you'll need a build system capable of loading NPM packages on the client. Some common choices include Browserify, Webpack, and Meteor 1.3+.

Install the Apollo Client Developer tools for Chrome for a great GraphQL developer experience!

Usage

You get started by constructing an instance of the core class ApolloClient. If you load ApolloClient from the apollo-boost package, it will be configured with a few reasonable defaults such as our standard in-memory cache and a link to a GraphQL API at /graphql.

import ApolloClient from 'apollo-boost';

const client = new ApolloClient();

To point ApolloClient at a different URL, add your GraphQL API's URL to the uri config property:

import ApolloClient from 'apollo-boost';

const client = new ApolloClient({
  uri: 'https://graphql.example.com'
});

Most of the time you'll hook up your client to a frontend integration. But if you'd like to directly execute a query with your client, you may now call the client.query method like this:

import gql from 'graphql-tag';

client.query({
  query: gql`
    query TodoApp {
      todos {
        id
        text
        completed
      }
    }
  `,
})
  .then(data => console.log(data))
  .catch(error => console.error(error));

Now your client will be primed with some data in its cache. You can continue to make queries, or you can get your client instance to perform all sorts of advanced tasks on your GraphQL data. Such as reactively watching queries with watchQuery, changing data on your server with mutate, or reading a fragment from your local cache with readFragment.

To learn more about all of the features available to you through the apollo-client package, be sure to read through the apollo-client API reference.

Learn how to use Apollo Client with your favorite framework


Contributing

Build status Build status Coverage Status

Read the Apollo Contributor Guidelines.

Running tests locally:

# nvm use node
npm install
npm run build
npm test

This project uses TypeScript for static typing and TSLint for linting. You can get both of these built into your editor with no configuration by opening this project in Visual Studio Code, an open source IDE which is available for free on all platforms.

Important discussions

If you're getting booted up as a contributor, here are some discussions you should take a look at:

  1. Static typing and why we went with TypeScript also covered in the Medium post
  2. Idea for pagination handling
  3. Discussion about interaction with Redux and domain vs. client state
  4. Long conversation about different client options, before this repo existed