Skip to content

Commit 8997c68

Browse files
authored
Merge pull request #12 from setchy/feature/doc-updates
Feature/doc updates
2 parents dbc9095 + b67ebd7 commit 8997c68

File tree

14 files changed

+297
-21
lines changed

14 files changed

+297
-21
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# [GraphQL Java Kickstart Documentation](https://www.graphql-java-kickstart.com/)
2-
[![Build Status](https://travis-ci.org/graphql-java-kickstart/documentation.svg?branch=master)](https://travis-ci.org/graphql-java-kickstart/documentation)
3-
[![Chat on Spectrum](https://img.shields.io/badge/spectrum-join%20the%20community-%23800080)](https://spectrum.chat/graphql-java-kick)
2+
3+
4+
[![GitHub CI Workflow](https://github.com/graphql-java-kickstart/documentation/actions/workflows/publish.yml/badge.svg?branch=master)](https://github.com/graphql-java-kickstart/documentation/actions/workflows/publish.yml?query=branch%3Amaster)
5+
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/documentation)](https://github.com/graphql-java-kickstart/documentation/graphs/contributors)
6+
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/graphql-spring-boot/discussions)
7+
8+
49

510
## We are looking for contributors!
611
Are you interested in improving our documentation, working on the codebase, reviewing PRs?
712

8-
[Reach out to us on Spectrum](https://spectrum.chat/graphql-java-kick) and join the team!
13+
[Reach out to us on Discussions](https://github.com/graphql-java-kickstart/graphql-spring-boot/discussions)
14+
and join the team!
915

1016
## Running the site locally
1117
1. Clone this repository

config.toml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,21 @@ googleAnalytics = ""
4949
url = "https://github.com/graphql-java-kickstart/graphql-spring-boot"
5050
menu = "Spring Boot"
5151

52+
[[params.repositories]]
53+
name = "graphql-java-kickstart/graphql-spring-webclient"
54+
url = "https://github.com/graphql-java-kickstart/graphql-spring-webclient"
55+
menu = "Web Client"
56+
57+
[[params.repositories]]
58+
name = "graphql-java-kickstart/samples"
59+
url = "https://github.com/graphql-java-kickstart/samples"
60+
menu = "Samples"
61+
62+
[[params.repositories]]
63+
name = "philip-jvm/learn-spring-boot-graphql"
64+
url = "https://github.com/philip-jvm/learn-spring-boot-graphql"
65+
menu = "Tutorials"
66+
5267
[params.logo]
5368
icon = ""
5469
image = "images/logo-graphql-kickstart-2000px.png"
@@ -83,6 +98,21 @@ googleAnalytics = ""
8398
url = "/spring-boot/"
8499
weight = 30
85100

101+
[[menu.main]]
102+
name = "Web Client"
103+
url = "/web-client/"
104+
weight = 40
105+
106+
[[menu.main]]
107+
name = "Samples"
108+
url = "/samples/"
109+
weight = 50
110+
111+
[[menu.main]]
112+
name = "Tutorials"
113+
url = "/tutorials/"
114+
weight = 60
115+
86116
[blackfriday]
87117
smartypants = true
88118
fractions = true

content/samples/_index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
date: 2021-04-09T17:50:13+01:00
3+
title: About GraphQL Kickstart Samples
4+
weight: 1
5+
type: index
6+
menu:
7+
main:
8+
parent: Samples
9+
---
10+
11+
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/samples)](https://github.com/graphql-java-kickstart/samples/graphs/contributors)
12+
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/samples/discussions)
13+
14+
## Overview
15+
16+
You can find a collection of samples projects within the [graphql-java-kickstart/samples](https://github.com/graphql-java-kickstart/samples) repository

content/servlet/_index.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,21 @@ menu:
88
parent: Servlet
99
---
1010

11+
[![Maven Central](https://img.shields.io/maven-central/v/com.graphql-java-kickstart/graphql-java-servlet.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-servlet)
12+
[![GitHub CI Workflow](https://github.com/graphql-java-kickstart/graphql-java-servlet/actions/workflows/snapshot.yml/badge.svg?branch=master)](https://github.com/graphql-java-kickstart/graphql-java-servlet/actions/workflows/snapshot.yml)
13+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=graphql-java-kickstart_graphql-java-servlet&metric=alert_status)](https://sonarcloud.io/dashboard?id=graphql-java-kickstart_graphql-java-servlet)
14+
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/graphql-java-servlet)](https://github.com/graphql-java-kickstart/graphql-java-servlet/graphs/contributors)
15+
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/graphql-java-servlet/discussions)
16+
17+
1118
Implementation of GraphQL Java Servlet including support for Relay.js, Apollo and OSGi out of the box.
1219
This project wraps the Java implementation of GraphQL provided by [GraphQL Java](https://www.graphql-java.com).
1320
The documentation on this site focuses around the usage of the servlet. Although some parts may dive deeper
1421
into the aspects of GraphQL Java as well, make sure to look at the
1522
[GraphQL Java documentation](https://www.graphql-java.com/documentation/latest/) for more in depth details
1623
regarding GraphQL Java itself.
1724

18-
We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 14.0**.
25+
We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 16.1**.
1926

2027
This project requires at least Java 8.
2128

@@ -37,7 +44,7 @@ repositories {
3744
Add the `graphql-java-servlet` dependency:
3845
```gradle
3946
dependencies {
40-
compile 'com.graphql-java-kickstart:graphql-java-servlet:9.1.0'
47+
compile 'com.graphql-java-kickstart:graphql-java-servlet:11.1.0'
4148
}
4249
```
4350

@@ -48,7 +55,7 @@ Add the `graphql-java-servlet` dependency:
4855
<dependency>
4956
<groupId>com.graphql-java-kickstart</groupId>
5057
<artifactId>graphql-java-servlet</artifactId>
51-
<version>9.1.0</version>
58+
<version>11.1.0</version>
5259
</dependency>
5360
```
5461

content/servlet/getting-started/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ plugins {
3030
3131
repositories {
3232
mavenCentral()
33-
jcenter()
3433
}
3534
3635
dependencies {
37-
compile 'com.graphql-java-kickstart:graphql-java-servlet:9.1.0'
36+
compile 'com.graphql-java-kickstart:graphql-java-servlet:11.1.0'
3837
}
3938
```
4039

@@ -53,7 +52,7 @@ Add the `graphql-java-servlet` dependency to your `dependencies` section:
5352
<dependency>
5453
<groupId>com.graphql-java-kickstart</groupId>
5554
<artifactId>graphql-java-servlet</artifactId>
56-
<version>9.1.0</version>
55+
<version>11.1.0</version>
5756
</dependency>
5857
```
5958

content/spring-boot/_index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ menu:
77
parent: Spring Boot
88
---
99

10+
[![Maven Central](https://img.shields.io/maven-central/v/com.graphql-java-kickstart/graphql-spring-boot-starter.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-spring-boot-starter)
11+
[![GitHub CI Workflow](https://github.com/graphql-java-kickstart/graphql-spring-boot/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/graphql-java-kickstart/graphql-spring-boot/actions/workflows/ci.yml?query=workflow%3ACI+branch%3Amaster)
12+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=graphql-java-kickstart_graphql-spring-boot&metric=alert_status)](https://sonarcloud.io/dashboard?id=graphql-java-kickstart_graphql-spring-boot)
13+
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/graphql-spring-boot)](https://github.com/graphql-java-kickstart/graphql-spring-boot/graphs/contributors)
14+
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/graphql-spring-boot/discussions)
15+
16+
1017
This library contains various Spring Boot starters to enable GraphQL related
1118
services or features.
1219

@@ -23,6 +30,10 @@ and [GraphQL-Java Annotations](https://github.com/Enigmatis/graphql-java-annotat
2330
* **graphiql-spring-boot-starter**: embeds the **GraphiQL** tool for schema
2431
introspection and query debugging (see [GraphiQL](https://github.com/graphql/graphiql))
2532

33+
* **playground-spring-boot-starter**: embeds the **GraphQL Playground** tool for schema
34+
introspection and query debugging (see [GraphQL Playground](https://github.com/prisma/graphql-playground))
35+
36+
2637
* **graphql-spring-boot-starter-test**: adds testing capabilities to your project,
2738
like the `@GraphQLTest` annotation which is comparable to `@SpringBootTest`
2839

content/spring-boot/getting-started/index.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ repositories {
3030
Add the respective starter dependencies you want to use:
3131
```gradle
3232
dependencies {
33-
compile 'com.graphql-java-kickstart:graphql-spring-boot-starter:7.0.1'
34-
compile 'com.graphql-java-kickstart:graphiql-spring-boot-starter:7.0.1'
35-
compile 'com.graphql-java-kickstart:voyager-spring-boot-starter:7.0.1'
36-
testCompile 'com.graphql-java-kickstart:graphql-spring-boot-starter-test:7.0.1'
33+
compile 'com.graphql-java-kickstart:graphql-spring-boot-starter:11.0.0'
34+
compile 'com.graphql-java-kickstart:graphiql-spring-boot-starter:11.0.0'
35+
compile 'com.graphql-java-kickstart:voyager-spring-boot-starter:11.0.0'
36+
testCompile 'com.graphql-java-kickstart:graphql-spring-boot-starter-test:11.0.0'
3737
}
3838
```
3939

@@ -44,29 +44,34 @@ Add the respective starter dependencies you want to use:
4444
<dependency>
4545
<groupId>com.graphql-java-kickstart</groupId>
4646
<artifactId>graphql-spring-boot-starter</artifactId>
47-
<version>7.0.1</version>
47+
<version>11.0.0</version>
4848
</dependency>
4949
<dependency>
5050
<groupId>com.graphql-java-kickstart</groupId>
5151
<artifactId>graphiql-spring-boot-starter</artifactId>
52-
<version>7.0.1</version>
52+
<version>11.0.0</version>
53+
</dependency>
54+
<dependency>
55+
<groupId>com.graphql-java-kickstart</groupId>
56+
<artifactId>playground-spring-boot-starter</artifactId>
57+
<version>11.0.0</version>
5358
</dependency>
5459
<dependency>
5560
<groupId>com.graphql-java-kickstart</groupId>
5661
<artifactId>voyager-spring-boot-starter</artifactId>
57-
<version>7.0.1</version>
62+
<version>11.0.0</version>
5863
</dependency>
5964
<dependency>
6065
<groupId>com.graphql-java-kickstart</groupId>
6166
<artifactId>graphql-spring-boot-starter-test</artifactId>
62-
<version>7.0.1</version>
67+
<version>11.0.0</version>
6368
<scope>test</scope>
6469
</dependency>
6570
```
6671

6772
## Using the latest development build
6873

69-
Snapshot versions of the current `master` branch are availble on JFrog. Check the next snapshot version on
74+
Snapshot versions of the current `master` branch are available on JFrog. Check the next snapshot version on
7075
[Github](https://github.com/graphql-java-kickstart/graphql-java-tools/blob/master/gradle.properties)
7176

7277
### Build with Gradle

content/tools/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ menu:
88
parent: Tools
99
---
1010

11-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-tools/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-tools)
11+
[![Maven Central](https://img.shields.io/maven-central/v/com.graphql-java-kickstart/graphql-java-tools.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-tools)
12+
[![TravisCI Build](https://travis-ci.org/graphql-java-kickstart/graphql-java-tools.svg?branch=master)](https://travis-ci.org/graphql-java-kickstart/graphql-java-tools)
13+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=graphql-java-kickstart_graphql-java-tools&metric=alert_status)](https://sonarcloud.io/dashboard?id=graphql-java-kickstart_graphql-java-tools)
14+
[![GitHub contributors](https://img.shields.io/github/contributors/graphql-java-kickstart/graphql-java-tools)](https://github.com/graphql-java-kickstart/graphql-java-tools/graphs/contributors)
15+
[![Discuss on GitHub](https://img.shields.io/badge/GitHub-discuss-orange)](https://github.com/graphql-java-kickstart/graphql-java-tools/discussions)
1216

1317
This library allows you to use the GraphQL schema language to build your [graphql-java](https://github.com/graphql-java/graphql-java) schema.
1418
Inspired by [graphql-tools](https://github.com/apollographql/graphql-tools), it parses the given GraphQL schema and allows you to BYOO (bring your own object) to fill in the implementations.

content/tools/getting-started/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ repositories {
3232
Add the `graphql-java-tools` dependency:
3333
```gradle
3434
dependencies {
35-
compile 'com.graphql-java-kickstart:graphql-java-tools:6.0.2'
35+
compile 'com.graphql-java-kickstart:graphql-java-tools:11.0.0'
3636
}
3737
```
3838

@@ -43,7 +43,7 @@ Add the `graphql-java-tools` dependency:
4343
<dependency>
4444
<groupId>com.graphql-java-kickstart</groupId>
4545
<artifactId>graphql-java-tools</artifactId>
46-
<version>6.0.2</version>
46+
<version>11.0.0</version>
4747
</dependency>
4848
```
4949

content/tutorials/_index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
date: 2021-04-09T17:50:13+01:00
3+
title: About Learn GraphQL Spring Boot
4+
weight: 1
5+
type: index
6+
menu:
7+
main:
8+
parent: Tutorials
9+
10+
---
11+
12+
## Learn GraphQL Spring Boot Course
13+
14+
[Philip Starritt](https://github.com/philip-jvm) has published an excellent tutorial series on YouTube, which provides a hands-on approach to learning GraphQL Spring Boot.
15+
16+
You can also find the implementation examples from the tutorial series at [philip-jvm/learn-spring-boot-graphql](https://github.com/philip-jvm/learn-spring-boot-graphql)
17+
18+
19+
## Playlist
20+
Check out the full [Spring Boot GraphQL Tutorial YouTube Playlist](https://www.youtube.com/playlist?list=PLiwhu8iLxKwL1TU0RMM6z7TtkyW-3-5Wi) for the latest set of videos

0 commit comments

Comments
 (0)