Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Commit

Permalink
fix(docs): better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dacz committed Nov 27, 2017
1 parent 97f1df3 commit ed36039
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 17 deletions.
52 changes: 36 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,37 @@

When you don't have GraphQL server (yet) and want to use GraphQL on the client.

Use your own resolvers to non-graphql endpoints (like REST API, querying filesystem in electron app etc.).
[_Demo: working example with source code and server._](https://github.com/dacz/apollo-bridge-link-example)

Use your own resolvers to non-graphql endpoints (like REST API, querying
filesystem in electron app etc.).

[![current version](https://img.shields.io/npm/v/apollo-bridge-link.svg?style=flat-square)](https://www.npmjs.com/package/apollo-bridge-link)
[![travis.ci](https://img.shields.io/travis/dacz/apollo-bridge-link.svg?style=flat-square)](https://travis-ci.org/dacz/apollo-bridge-link)
[![codecov](https://codecov.io/gh/dacz/apollo-bridge-link/branch/master/graph/badge.svg)](https://codecov.io/gh/dacz/apollo-bridge-link)
[![Greenkeeper badge](https://badges.greenkeeper.io/dacz/apollo-bridge-link.svg)](https://greenkeeper.io/)
[![license](https://img.shields.io/github/license/dacz/apollo-bridge-link.svg)](https://github.com/dacz/apollo-bridge-link/blob/master/LICENSE)


## Idea

GraphQL client side development is great experience. But more then often company doen't have GraphQL server (yet). Bridge allows you to resolve GraphQL queries and mutations the way you want (facing REST API eg.)

Allows gradual implementing of GraphQL within your project and doesn't require to change backend. Schema created along the way will be corner stone for full adoption of GraphQL.
GraphQL client side development is great experience. But more then often company
doesn't have GraphQL server (yet). Bridge allows you to resolve GraphQL queries
and mutations the way you want (facing REST API eg.)

Allows gradual implementing of GraphQL within your project and doesn't require
to change backend. Schema created along the way will be corner stone for full
adoption of GraphQL on the backend.

## Implementation

We created this tool for us to deliver web and native app. We use Apollo tools and therefore this is implemented as Apollo Link. Because Apollo client v2.0 and Apollo Link etc. is still wip (and moving target), this is experimental.
We created this tool for us to deliver web and native app. We use Apollo tools
and therefore this is implemented as Apollo Link.

The basic implementation is simple: this link allows you to create link that accepts your schema and your resolvers. You can even mock the schema on the client.
The basic implementation is simple: this link allows you to create link that
accepts your schema and your resolvers. You can even mock the schema on the
client.

The tools for easily facing eg. REST server will come.
[_Demo: working example with source code and server._](https://github.com/dacz/apollo-bridge-link-example)

## How to use

Expand All @@ -37,17 +45,17 @@ npm install apollo-client@beta apollo-bridge-link apollo-cache-inmemory@beta
### create Apollo client

```javascript
import ApolloClient from 'apollo-client';
import { ApolloClient } from 'apollo-client';
import { BridgeLink } from 'apollo-bridge-link';
import InMemoryCache from 'apollo-cache-inmemory';
import { InMemoryCache } from 'apollo-cache-inmemory';

// your prepared schema (as txt or parsed)
import schema from './schema';

// you resolvers
// your resolvers (see example)
import reolvers from './resolvers';

// if you want to mock anything in the schema (that has not resolver)
// if you want to mock anything in the schema (that has not resolver or doesn't return data)
const mock = true;

// if you want to push something down to the resolvers in context
Expand All @@ -61,19 +69,31 @@ export const client = new ApolloClient({
});
```

... more details to come
Then use your graphQl queries and mutation as you would be facing GraphQL
server.

[_Demo: working example with source code and server._](https://github.com/dacz/apollo-bridge-link-example)

## Need help, want help?

I eat my dog (cat, actually) food - I use this for client's projects. I do not
have enough time to put all enhancements into this library, but I am catching
up.

If you are developer, please submit issue or PR.

If you are company and want to help with implementing GraphQL (server/web app/react native apps), hire us. We are passionate programmers (Node, React, ReactNative, GraphQl, ... ).
If you are company and want to help with implementing GraphQL (server/web
app/react native apps) and need help, ask me. I'm passionate programmer (Node,
React, GraphQl, ... ) and usually working in a team with more skills like
ReactNative.

## To Do

* [ ] make example (against REST, with dataloader)
* [x] make example (against REST, with dataloader) - see
[here](https://github.com/dacz/apollo-bridge-link-example)
* [ ] make better build

## Sponsors

**LiveAndCode** - passionate group of javascript developers (contact [email protected]). Thanks!
**LiveAndCode** - passionate group of javascript developers (contact
[email protected]). Thanks!
2 changes: 1 addition & 1 deletion src/bridgeLink.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const createBridgeLink = ({ schema, resolvers, mock, context = {} }) => {
executableSchema = schema;
} else {
throw new Error(
'schema should be plain text, parsed schema or executable schema.'
'schema should be plain text, parsed schema or executable schema'
);
}

Expand Down

0 comments on commit ed36039

Please sign in to comment.