ps-apollo-client
v0.8.3
Published
A simple yet functional GraphQL client.
Downloads
3
Maintainers
Readme
Apollo client
Apollo Client can be used in any JavaScript frontend where you want to use data from a GraphQL server. It's:
- Incrementally adoptable, so that you can drop it into an existing JavaScript app and start using GraphQL for just part of your UI.
- Universally compatible, so that Apollo works with any build setup, any GraphQL server, and any GraphQL schema.
- Simple to get started with, you can start loading data right away and learn about advanced features later.
- Inspectable and understandable, so that you can have great developer tools to understand exactly what is happening in your app.
- Built for interactive apps, so your users can make changes and see them reflected in the UI immediately.
- Small and flexible, so you don't get stuff you don't need. The core is under 25kb compressed.
- Community driven, 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
npm install apollo-client
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.
NEW: Install the Apollo Client Developer tools for Chrome for a great GraphQL developer experience!
Learn how to use Apollo Client with your favorite framework
Contributing
Read the Apollo Contributor Guidelines.
Running tests locally:
# nvm use node
npm install
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.
Useful tools
Should be moved into some kind of CONTRIBUTING.md soon...
- AST explorer: you can use this to see what the GraphQL query AST looks like for different queries
Important discussions
If you're getting booted up as a contributor, here are some discussions you should take a look at: