Skip to content

Commit 669ef63

Browse files
Generate README.md for examples (#484)
Co-authored-by: theguild-bot <[email protected]>
1 parent 86c3f15 commit 669ef63

File tree

37 files changed

+1031
-103
lines changed

37 files changed

+1031
-103
lines changed

examples/apq-subgraphs/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# apq-subgraphs
2+
3+
## How to open in CodeSandbox?
4+
5+
This example is available online as a [CodeSandbox Devbox](https://codesandbox.io/docs/learn/devboxes/overview).
6+
7+
Visit [githubbox.com/graphql-hive/gateway/tree/main/examples/apq-subgraphs](https://githubbox.com/graphql-hive/gateway/tree/main/examples/apq-subgraphs).
8+
9+
ℹ️ You can open an example from other branches by changing the `/tree/main` to the branch name (`/tree/<branch_name>`) in the URL above.
10+
11+
## How to run locally?
12+
13+
1. Download example
14+
```sh
15+
curl -L https://github.com/graphql-hive/gateway/raw/refs/heads/main/examples/apq-subgraphs/example.tar.gz | tar -x
16+
```
17+
18+
ℹ️ You can download examples from other branches by changing the `/refs/heads/main` to the branch name (`/refs/heads/<branch_name>`) in the URL above.
19+
20+
1. Open example
21+
```sh
22+
cd apq-subgraphs
23+
```
24+
1. Install
25+
```sh
26+
npm i
27+
```
28+
1. Start service greetings
29+
```sh
30+
npm run service:greetings
31+
```
32+
1. Compose
33+
```sh
34+
npm run compose
35+
```
36+
1. Start the gateway
37+
```sh
38+
npm run gateway
39+
```
40+
41+
🚀 Then visit [localhost:4000/graphql](http://localhost:4000/graphql) to see Hive Gateway in action!
42+
43+
## Note
44+
45+
This example was auto-generated from the [apq-subgraphs E2E test](/e2e/apq-subgraphs) using our [example converter](/internal/examples).
46+
47+
You can browse the [apq-subgraphs.e2e.ts test file](/e2e/apq-subgraphs/apq-subgraphs.e2e.ts) to understand what to expect.
67.7 KB
Binary file not shown.

examples/extra-fields/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# extra-fields
2+
3+
## How to open in CodeSandbox?
4+
5+
This example is available online as a [CodeSandbox Devbox](https://codesandbox.io/docs/learn/devboxes/overview).
6+
7+
Visit [githubbox.com/graphql-hive/gateway/tree/main/examples/extra-fields](https://githubbox.com/graphql-hive/gateway/tree/main/examples/extra-fields).
8+
9+
ℹ️ You can open an example from other branches by changing the `/tree/main` to the branch name (`/tree/<branch_name>`) in the URL above.
10+
11+
## How to run locally?
12+
13+
1. Download example
14+
```sh
15+
curl -L https://github.com/graphql-hive/gateway/raw/refs/heads/main/examples/extra-fields/example.tar.gz | tar -x
16+
```
17+
18+
ℹ️ You can download examples from other branches by changing the `/refs/heads/main` to the branch name (`/refs/heads/<branch_name>`) in the URL above.
19+
20+
1. Open example
21+
```sh
22+
cd extra-fields
23+
```
24+
1. Install
25+
```sh
26+
npm i
27+
```
28+
1. Start service foo
29+
```sh
30+
npm run service:foo
31+
```
32+
1. Start service bar
33+
```sh
34+
npm run service:bar
35+
```
36+
1. Compose
37+
```sh
38+
npm run compose
39+
```
40+
1. Start the gateway
41+
```sh
42+
npm run gateway
43+
```
44+
45+
🚀 Then visit [localhost:4000/graphql](http://localhost:4000/graphql) to see Hive Gateway in action!
46+
47+
## Note
48+
49+
This example was auto-generated from the [extra-fields E2E test](/e2e/extra-fields) using our [example converter](/internal/examples).
50+
51+
You can browse the [extra-fields.e2e.ts test file](/e2e/extra-fields/extra-fields.e2e.ts) to understand what to expect.
57 KB
Binary file not shown.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# federation-example
2+
3+
## How to open in CodeSandbox?
4+
5+
This example is available online as a [CodeSandbox Devbox](https://codesandbox.io/docs/learn/devboxes/overview).
6+
7+
Visit [githubbox.com/graphql-hive/gateway/tree/main/examples/federation-example](https://githubbox.com/graphql-hive/gateway/tree/main/examples/federation-example).
8+
9+
ℹ️ You can open an example from other branches by changing the `/tree/main` to the branch name (`/tree/<branch_name>`) in the URL above.
10+
11+
## How to run locally?
12+
13+
1. Download example
14+
```sh
15+
curl -L https://github.com/graphql-hive/gateway/raw/refs/heads/main/examples/federation-example/example.tar.gz | tar -x
16+
```
17+
18+
ℹ️ You can download examples from other branches by changing the `/refs/heads/main` to the branch name (`/refs/heads/<branch_name>`) in the URL above.
19+
20+
1. Open example
21+
```sh
22+
cd federation-example
23+
```
24+
1. Install
25+
```sh
26+
npm i
27+
```
28+
1. Start service accounts
29+
```sh
30+
npm run service:accounts
31+
```
32+
1. Start service inventory
33+
```sh
34+
npm run service:inventory
35+
```
36+
1. Start service products
37+
```sh
38+
npm run service:products
39+
```
40+
1. Start service reviews
41+
```sh
42+
npm run service:reviews
43+
```
44+
1. Compose
45+
```sh
46+
npm run compose
47+
```
48+
1. Start the gateway
49+
```sh
50+
npm run gateway
51+
```
52+
53+
🚀 Then visit [localhost:4000/graphql](http://localhost:4000/graphql) to see Hive Gateway in action!
54+
55+
## Note
56+
57+
This example was auto-generated from the [federation-example E2E test](/e2e/federation-example) using our [example converter](/internal/examples).
58+
59+
You can browse the [federation-example.e2e.ts test file](/e2e/federation-example/federation-example.e2e.ts) to understand what to expect.
68.9 KB
Binary file not shown.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# federation-mixed
2+
3+
## How to open in CodeSandbox?
4+
5+
This example is available online as a [CodeSandbox Devbox](https://codesandbox.io/docs/learn/devboxes/overview).
6+
7+
Visit [githubbox.com/graphql-hive/gateway/tree/main/examples/federation-mixed](https://githubbox.com/graphql-hive/gateway/tree/main/examples/federation-mixed).
8+
9+
ℹ️ You can open an example from other branches by changing the `/tree/main` to the branch name (`/tree/<branch_name>`) in the URL above.
10+
11+
## How to run locally?
12+
13+
1. Download example
14+
```sh
15+
curl -L https://github.com/graphql-hive/gateway/raw/refs/heads/main/examples/federation-mixed/example.tar.gz | tar -x
16+
```
17+
18+
ℹ️ You can download examples from other branches by changing the `/refs/heads/main` to the branch name (`/refs/heads/<branch_name>`) in the URL above.
19+
20+
1. Open example
21+
```sh
22+
cd federation-mixed
23+
```
24+
1. Install
25+
```sh
26+
npm i
27+
```
28+
1. Start service accounts
29+
```sh
30+
npm run service:accounts
31+
```
32+
1. Start service inventory
33+
```sh
34+
npm run service:inventory
35+
```
36+
1. Start service products
37+
```sh
38+
npm run service:products
39+
```
40+
1. Start service reviews
41+
```sh
42+
npm run service:reviews
43+
```
44+
1. Compose
45+
```sh
46+
npm run compose
47+
```
48+
1. Start the gateway
49+
```sh
50+
npm run gateway
51+
```
52+
53+
🚀 Then visit [localhost:4000/graphql](http://localhost:4000/graphql) to see Hive Gateway in action!
54+
55+
## Note
56+
57+
This example was auto-generated from the [federation-mixed E2E test](/e2e/federation-mixed) using our [example converter](/internal/examples).
58+
59+
You can browse the [federation-mixed.e2e.ts test file](/e2e/federation-mixed/federation-mixed.e2e.ts) to understand what to expect.
75.3 KB
Binary file not shown.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# federation-subscriptions-passthrough
2+
3+
## How to open in CodeSandbox?
4+
5+
This example is available online as a [CodeSandbox Devbox](https://codesandbox.io/docs/learn/devboxes/overview).
6+
7+
Visit [githubbox.com/graphql-hive/gateway/tree/main/examples/federation-subscriptions-passthrough](https://githubbox.com/graphql-hive/gateway/tree/main/examples/federation-subscriptions-passthrough).
8+
9+
ℹ️ You can open an example from other branches by changing the `/tree/main` to the branch name (`/tree/<branch_name>`) in the URL above.
10+
11+
## How to run locally?
12+
13+
1. Download example
14+
```sh
15+
curl -L https://github.com/graphql-hive/gateway/raw/refs/heads/main/examples/federation-subscriptions-passthrough/example.tar.gz | tar -x
16+
```
17+
18+
ℹ️ You can download examples from other branches by changing the `/refs/heads/main` to the branch name (`/refs/heads/<branch_name>`) in the URL above.
19+
20+
1. Open example
21+
```sh
22+
cd federation-subscriptions-passthrough
23+
```
24+
1. Install
25+
```sh
26+
npm i
27+
```
28+
1. Start service products
29+
```sh
30+
npm run service:products
31+
```
32+
1. Start service reviews
33+
```sh
34+
npm run service:reviews
35+
```
36+
1. Compose
37+
```sh
38+
npm run compose
39+
```
40+
1. Start the gateway
41+
```sh
42+
npm run gateway
43+
```
44+
45+
🚀 Then visit [localhost:4000/graphql](http://localhost:4000/graphql) to see Hive Gateway in action!
46+
47+
## Note
48+
49+
This example was auto-generated from the [federation-subscriptions-passthrough E2E test](/e2e/federation-subscriptions-passthrough) using our [example converter](/internal/examples).
50+
51+
You can browse the [federation-subscriptions-passthrough.e2e.ts test file](/e2e/federation-subscriptions-passthrough/federation-subscriptions-passthrough.e2e.ts) to understand what to expect.
70.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)