Skip to content

Commit f194b2c

Browse files
author
IntroPro Ventures
authored
Updated Readme build instructions with jitpack.io
1 parent 342ae18 commit f194b2c

File tree

1 file changed

+44
-9
lines changed

1 file changed

+44
-9
lines changed

README.md

+44-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
GraphQL Query for JPA Entity Model
22
===============
3+
34
This library uses [graphql-java v3.0](https://github.com/andimarek/graphql-java) to derive and build the GraphQL schema from JPA Entity Schema provided by entity classes.
45

56
It implements a schema builder to generate GraphQL Schema using JPA EntityManager with JPA Query Data Fetchers that transform GraphQL queries into JPA queries with flexible type safe criteria expressions and user-friendly SQL query syntax semantics i.e. query by page, , where criteria expressions, select, order by etc.
@@ -9,14 +10,48 @@ Modules
910
The GraphQL-JPA-Query library consists of the following modules:
1011

1112
1. `graphql-jpa-query-annotations` - Provides annotations for instrumenting your entity models with GraphQL Schema Descriptions
12-
2. `graphql-jpa-query-schema` - Provides interface specifications and implementation of the JPA schema builder and JPA data fetchers
13+
2. `graphql-jpa-query-schema` - Provides interface specifications and implementation of the JPA Schema Builder and JPA Data Fetchers
1314
3. `graphql-jpa-query-boot-starter`- Provides Spring Boot auto-configuration support to enable GraphQL JPA Query in your project
1415
4. `graphql-jpa-query-example` - Provides example application for Books entity models
1516

16-
Dependencies
17+
Building with jitpack.io [![Release](https://jitpack.io/v/introproventures/graphql-jpa-query.svg)](https://jitpack.io/#introproventures/graphql-jpa-query)
18+
------------------------
19+
You can simply use jitpack.io to include and build individual modules in your project. You will need to add jitpack.io repository in our project to resolve required artifacts using valid release tag.
20+
21+
<repositories>
22+
<repository>
23+
<id>jitpack.io</id>
24+
<url>https://jitpack.io</url>
25+
</repository>
26+
</repositories>
27+
28+
For GraphQL JPA Annotations use:
29+
30+
<dependency>
31+
<groupId>com.github.introproventures.graphql-jpa-query</groupId>
32+
<artifactId>graphql-jpa-query-annotations</artifactId>
33+
<version>v0.1.0</version>
34+
</dependency>
35+
36+
For GraphQL JPA Schema Builder use:
37+
38+
<dependency>
39+
<groupId>com.github.introproventures.graphql-jpa-query</groupId>
40+
<artifactId>graphql-jpa-query-schema</artifactId>
41+
<version>v0.1.0</version>
42+
</dependency>
43+
44+
For GraphQL JPA Query Boot Starter use:
45+
46+
<dependency>
47+
<groupId>com.github.introproventures.graphql-jpa-query</groupId>
48+
<artifactId>graphql-jpa-query-boot-starter</artifactId>
49+
<version>v0.1.0</version>
50+
</dependency>
51+
52+
Other Dependencies
1753
-----------------
18-
The library tries to keep the following dependencies: graphql-java, and some javax Jpa 2.1 packages. The tests depend
19-
on Spring Boot with Hibernate for JPA.
54+
The core library module `graphql-jpa-query-schema` keeps dependencies to a minimum. The main dependecies for schema module are `graphql-java`, `evo-inflector`, `javax.transaction-api`, `hibernate-jpa-2.1-api`. The tests depend on Spring Boot 1.5 with Web and Hibernate for JPA starters.
2055

2156
Schema Generation
2257
-----------------
@@ -242,14 +277,14 @@ Performance
242277
-----------
243278
The JPA DataFetcher implementation will attempt to build dynamic fetch graph in order to optimize query performance and avoid N+1 lazy loading.
244279

245-
GraphiQL Browser
280+
Examples
246281
--------
247282

248-
GraphiQL (https://github.com/graphql/graphiql) can be used for simple testing. You can launch provided example as Spring Boot Application, and navigate to http://localhost:8080/ to load GraphiQL browser. The collapsed Docs panel can opened by clicking on the button in the upper right corner, that when expanded will show you the running test schema.
283+
GraphiQL (https://github.com/graphql/graphiql) can be used for simple testing. You can build and launch provided example as a Spring Boot Application, then navigate to http://localhost:8080/ to load GraphiQL browser. The collapsed Docs panel can opened by clicking on the button in the upper right corner to expose current test schema models.
249284

250-
You can run GraphQL queries in the left pannel, and hit the run button, and the results should come back in the right
251-
panel. If your query has variables, there is a minimized panel at the bottom left. Simply click on this to expand, and
252-
type in your variables as a JSON string (don't forget to quote the keys!).
285+
You can run GraphQL queries in the left pannel. Type the query and hit the run button. The results should come up in the middle
286+
panel. If your query has variables, there is a minimized panel at the bottom left. Simply click on this to expand, and
287+
type in your variables as a JSON string with quoted keys.
253288

254289
License
255290
-------

0 commit comments

Comments
 (0)