• Stars
    star
    635
  • Rank 68,069 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 5 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🔥Lightning-fast, globally distributed Apollo GraphQL server, deployed at the edge using Cloudflare Workers

workers-graphql-server

An Apollo GraphQL server, built with Cloudflare Workers. Try a demo by looking at a deployed GraphQL playground.

Why this rules: Cloudflare Workers is a serverless application platform for deploying your projects across Cloudflare's massive distributed network. Deploying your GraphQL application to the edge is a huge opportunity to build consistent low-latency API servers, with the added benefits of "serverless" (I know, the project has server in it): usage-based pricing, no cold starts, and instant, easy-to-use deployment software, using Wrangler.

By the way - as a full-stack 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!

Deploy to Cloudflare Workers

Usage

You can begin building your own Workers GraphQL server by installing Wrangler, the Workers command-line tool, and generating a new project:

wrangler generate my-graphql-server https://github.com/cloudflare/workers-graphql-server

You'll need to configure your project's wrangler.toml file to prepare your project for deployment. See the "Configuration" docs for a guide on how to do this. Note that you'll need to find your Cloudflare API keys to set up your config file.

The source for this project includes an example external REST data source, and defined types for the PokeAPI, as an example of how to integrate external APIs. Once you have the worker available, try this query as a sanity check:

query samplePokeAPIquery {
  pokemon: pokemon(id:1) {
    id,
    name,
    height,
    weight,
    sprites{
      front_shiny,
      back_shiny
    }
  }
}

To start using the project, configure your graphQLOptions object in src/index.js:

const graphQLOptions = {
  baseEndpoint: '/', // String
  playgroundEndpoint: '/___graphql', // ?String
  forwardUnmatchedRequestsToOrigin: false, // Boolean
  debug: false, // Boolean
  cors: true, // Boolean or Object to further configure
  kvCache: false, // Boolean
}

Endpoints

Make requests to your GraphQL server at the baseEndpoint (e.g. graphql-on-workers.signalnerve.com/) and, if configured, try GraphQL queries at the playgroundEndpoint (e.g. graphql-on-workers.signalnerve.com/___graphql).

Origin forwarding

If you run your GraphQL server on a domain already registered with Cloudflare, you may want to pass any unmatched requests from inside your Workers script to your origin: in that case, set forwardUnmatchedRequestToOrigin to true (if you're running a GraphQL server on a Workers.dev subdomain, the default of false is fine).

Debugging

While configuring your server, you may want to set the debug flag to true, to return script errors in your browser. This can be useful for debugging any errors while setting up your GraphQL server, but should be disabled on a production server.

CORS

By default, the cors option allows cross-origin requests to the server from any origin. You may wish to configure it to whitelist specific origins, methods, or headers. To do this, change the cors option to an object:

const graphQLOptions = {
  // ... other options ...

  cors: {
    allowCredentials: 'true',
    allowHeaders: 'Content-type',
    allowOrigin: '*',
    allowMethods: 'GET, POST, PUT',
  },
}

Note that by default, any field that you don't pass here (e.g. allowMethods) will fallback to the default value. See utils/setCors.js for the default values for these fields.

REST caching

Version 1.1.0 of this project includes support for caching external requests made via instances of RESTDataSource, using KV. To use caching in your project, create a new KV namespace, and in wrangler.toml, configure your namespace, calling it WORKERS_GRAPHQL_CACHE:

# wrangler.toml

[[kv-namespaces]]
binding = "WORKERS_GRAPHQL_CACHE"
id = "$myId"

With a configured KV namespace set up, you can opt-in to KV caching by changing the kvCache config value in graphQLOptions (in index.js) to true.

License

This project is licensed with the MIT License.

More Repositories

1

quiche

🥧 Savoury implementation of the QUIC transport protocol and HTTP/3
Rust
8,654
star
2

cfssl

CFSSL: Cloudflare's PKI and TLS toolkit
Go
8,049
star
3

cloudflared

Cloudflare Tunnel client (formerly Argo Tunnel)
Go
5,870
star
4

boringtun

Userspace WireGuard® Implementation in Rust
Rust
5,768
star
5

workerd

The JavaScript / Wasm runtime that powers Cloudflare Workers
C++
5,680
star
6

flan

A pretty sweet vulnerability scanner
Python
3,910
star
7

miniflare

🔥 Fully-local simulator for Cloudflare Workers. For the latest version, see https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare.
TypeScript
3,656
star
8

wrangler-legacy

🤠 Home to Wrangler v1 (deprecated)
Rust
3,233
star
9

cloudflare-docs

Cloudflare’s documentation
CSS
2,578
star
10

tableflip

Graceful process restarts in Go
Go
2,549
star
11

workers-rs

Write Cloudflare Workers in 100% Rust via WebAssembly
Rust
2,182
star
12

workers-sdk

⛅️ Home to Wrangler, the CLI for Cloudflare Workers®
TypeScript
2,047
star
13

wildebeest

Wildebeest is an ActivityPub and Mastodon-compatible server
TypeScript
2,026
star
14

gokey

A simple vaultless password manager in Go
Go
1,836
star
15

ebpf_exporter

Prometheus exporter for custom eBPF metrics
C
1,639
star
16

lol-html

Low output latency streaming HTML parser/rewriter with CSS selector-based API
Rust
1,388
star
17

redoctober

Go server for two-man rule style file encryption and decryption.
Go
1,373
star
18

cf-ui

💎 Cloudflare UI Framework
JavaScript
1,297
star
19

sslconfig

Cloudflare's Internet facing SSL configuration
1,287
star
20

cloudflare-go

Go library for the Cloudflare v4 API
Go
1,246
star
21

foundations

Cloudflare's Rust service foundations library.
Rust
1,163
star
22

hellogopher

Hellogopher: "just clone and make" your conventional Go project
Makefile
1,153
star
23

production-saas

(WIP) Example SaaS application built in public on the Cloudflare stack!
TypeScript
1,099
star
24

bpftools

BPF Tools - packet analyst toolkit
Python
1,087
star
25

cloudflare-blog

Cloudflare Blog code samples
C
1,065
star
26

wrangler-action

🧙‍♀️ easily deploy cloudflare workers applications using wrangler and github actions
TypeScript
993
star
27

templates

A collection of starter templates and examples for Cloudflare Workers and Pages
JavaScript
979
star
28

circl

CIRCL: Cloudflare Interoperable Reusable Cryptographic Library
Go
970
star
29

wirefilter

An execution engine for Wireshark-like filters
Rust
913
star
30

pingora

A library for building fast, reliable and evolvable network services.
Rust
896
star
31

next-on-pages

CLI to build and develop Next.js apps for Cloudflare Pages
TypeScript
845
star
32

utahfs

UtahFS is an encrypted storage system that provides a user-friendly FUSE drive backed by cloud storage.
Go
805
star
33

cf-terraforming

A command line utility to facilitate terraforming your existing Cloudflare resources.
Go
793
star
34

workers-chat-demo

JavaScript
779
star
35

pint

Prometheus rule linter/validator
Go
772
star
36

Stout

A reliable static website deploy tool
Go
749
star
37

goflow

The high-scalability sFlow/NetFlow/IPFIX collector used internally at Cloudflare.
Go
729
star
38

unsee

Alert dashboard for Prometheus Alertmanager
Go
710
star
39

terraform-provider-cloudflare

Cloudflare Terraform Provider
Go
704
star
40

mitmengine

A MITM (monster-in-the-middle) detection tool. Used to build MALCOLM:
Go
690
star
41

react-gateway

Render React DOM into a new context (aka "Portal")
JavaScript
569
star
42

xdpcap

tcpdump like XDP packet capture
Go
567
star
43

cloudflare-php

PHP library for the Cloudflare v4 API
PHP
566
star
44

ahocorasick

A Golang implementation of the Aho-Corasick string matching algorithm
Go
541
star
45

lua-resty-logger-socket

Raw-socket-based Logger Library for Nginx (based on ngx_lua)
Perl
477
star
46

nginx-google-oauth

Lua module to add Google OAuth to nginx
Lua
425
star
47

gokeyless

Go implementation of the keyless protocol
Go
420
star
48

worker-typescript-template

ʕ •́؈•̀) TypeScript template for Cloudflare Workers
TypeScript
416
star
49

golibs

Various small golang libraries
Go
402
star
50

stpyv8

Python 3 and JavaScript interoperability. Successor To PyV8 (https://github.com/flier/pyv8)
C++
388
star
51

sandbox

Simple Linux seccomp rules without writing any code
C
385
star
52

mmap-sync

Rust library for concurrent data access, using memory-mapped files, zero-copy deserialization, and wait-free synchronization.
Rust
380
star
53

speedtest

Component to perform network speed tests against Cloudflare's edge network
JavaScript
371
star
54

mmproxy

mmproxy, the magical PROXY protocol gateway
C
370
star
55

pages-action

JavaScript
355
star
56

rustwasm-worker-template

A template for kick starting a Cloudflare Worker project using workers-rs. Write your Cloudflare Worker entirely in Rust!
Rust
350
star
57

workers-types

TypeScript type definitions for authoring Cloudflare Workers.
TypeScript
350
star
58

cobweb

COBOL to WebAssembly compiler
COBOL
345
star
59

cloudflare-ingress-controller

A Kubernetes ingress controller for Cloudflare's Argo Tunnels
Go
344
star
60

lua-resty-cookie

Lua library for HTTP cookie manipulations for OpenResty/ngx_lua
Perl
340
star
61

svg-hush

Make it safe to serve untrusted SVG files
Rust
333
star
62

boring

BoringSSL bindings for the Rust programming language.
Rust
330
star
63

node-cloudflare

Node.js API for Client API
JavaScript
319
star
64

cfweb3

JavaScript
309
star
65

workerskv.gui

(WIP) A cross-platform Desktop application for exploring Workers KV Namespace data
Svelte
307
star
66

JSON.is

Open-source documentation for common JSON formats.
JavaScript
302
star
67

sqlalchemy-clickhouse

Python
299
star
68

cloudflare.github.io

Cloudflare ❤️ Open Source
CSS
298
star
69

json-schema-tools

Packages for working with JSON Schema and JSON Hyper-Schema
JavaScript
296
star
70

chatgpt-plugin

Build ChatGPT plugins with Cloudflare's Developer Platform 🤖
JavaScript
290
star
71

tls-tris

crypto/tls, now with 100% more 1.3. THE API IS NOT STABLE AND DOCUMENTATION IS NOT GUARANTEED.
Go
283
star
72

gortr

The RPKI-to-Router server used at Cloudflare
Go
283
star
73

react-modal2

💭 Simple modal component for React.
JavaScript
279
star
74

doom-wasm

Chocolate Doom WebAssembly port with WebSockets support
C
273
star
75

keyless

Cloudflare's Keyless SSL Server Reference Implementation
C
272
star
76

isbgpsafeyet.com

Is BGP safe yet?
HTML
262
star
77

go

Go with Cloudflare experimental patches
Go
260
star
78

dog

Durable Object Groups
TypeScript
255
star
79

kv-asset-handler

Routes requests to KV assets
TypeScript
244
star
80

mod_cloudflare

C
243
star
81

tubular

BSD socket API on steroids
C
242
star
82

semver_bash

Semantic Versioning in Bash
Shell
238
star
83

cloudflare-rs

Rust library for the Cloudflare v4 API
Rust
236
star
84

cfssl_trust

CFSSL's CA trust store repository
Go
226
star
85

doca

A CLI tool that scaffolds API documentation based on JSON HyperSchemas.
JavaScript
224
star
86

pmtud

Path MTU daemon - broadcast lost ICMP packets on ECMP networks
C
218
star
87

alertmanager2es

Receives HTTP webhook notifications from AlertManager and inserts them into an Elasticsearch index for searching and analysis
Go
218
star
88

itty-router-openapi

OpenAPI 3 and 3.1 schema generator and validator for Cloudflare Workers
TypeScript
218
star
89

origin-ca-issuer

Go
216
star
90

worker-template-router

JavaScript
216
star
91

cloudflare-docs-engine

A documentation engine built on Gatsby, powering Cloudflare’s docs https://github.com/cloudflare/cloudflare-docs
JavaScript
215
star
92

python-worker-hello-world

Python hello world for Cloudflare Workers
JavaScript
209
star
93

saffron

The cron parser powering Cron Triggers on Cloudflare Workers
Rust
207
star
94

Cloudflare-WordPress

A Cloudflare plugin for WordPress
PHP
204
star
95

certmgr

Automated certificate management using a CFSSL CA.
Go
202
star
96

collapsify

Collapsify inlines all the resources of a page into a single document
JavaScript
200
star
97

worker-speedtest-template

JavaScript
195
star
98

har-sanitizer

TypeScript
192
star
99

zkp-ecdsa

Proves knowledge of an ECDSA-P256 signature under one of many public keys that are stored in a list.
TypeScript
187
star
100

shellflip

Graceful process restarts in Rust
Rust
183
star