Skip to content

Commit 70a4200

Browse files
Update README
1 parent b4c6616 commit 70a4200

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1-
workers + graphql playground
1+
# workers-graphql-server
22

3-
deploying this project requires a KV binding called `GRAPHQL_ON_WORKERS` to be defined for your application. if you don't want to set this up, comment out [this line](https://github.com/signalnerve/workers-graphql/blob/master/src/handlers/apollo.js#L43) before deploy
3+
An [Apollo GraphQL](https://www.apollographql.com/) server, built with [Cloudflare Workers](https://workers.cloudflare.com). Includes a GraphiQL route for testing requests.
4+
5+
[Try a demo by looking at the GraphiQL explorer](https://graphql-on-workers.signalnerve.com/graphiql).
6+
7+
## Usage
8+
9+
You can begin building your own Workers GraphQL server by [installing Wrangler](https://workers.cloudflare.com/docs/quickstart/), the Workers command-line tool, and generating a new project:
10+
11+
```
12+
wrangler generate my-graphql-server https://github.com/signalnerve/workers-graphql-server
13+
```
14+
15+
The source for this project includes an external REST data source, and defined types for the [PokeAPI](https://pokeapi.co/), as an example of how to integrate external APIs.
16+
17+
By the way - as a fullstack developer who _loves GraphQL_, and the developer advocate for Cloudflare Workers, I would love to see what you build with this! Let me know [on Twitter](https://twitter.com/signalnerve)!
18+
19+
## License
20+
21+
This project is licensed with the [MIT License](https://github.com/signalnerve/workers-graphql-server/blob/master/LICENSE).

0 commit comments

Comments
 (0)