Skip to content

Commit 31cbbcb

Browse files
Merge pull request #2 from intuit/circleci-project-setup
Circleci project setup
2 parents 6fb2931 + 8da7838 commit 31cbbcb

File tree

2 files changed

+39
-30
lines changed

2 files changed

+39
-30
lines changed

.circleci/config.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Use the latest 2.1 version of CircleCI pipeline process engine.
2+
# See: https://circleci.com/docs/2.0/configuration-reference
3+
version: 2.1
4+
5+
jobs:
6+
# Below is the definition of your job to build and test your app, you can rename and customize it as you want.
7+
build-and-test:
8+
# These next lines define a Docker executor: https://circleci.com/docs/2.0/executor-types/
9+
# You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
10+
# Be sure to update the Docker image tag below to openjdk version of your application.
11+
# A list of available CircleCI Docker Convenience Images are available here: https://circleci.com/developer/images/image/cimg/openjdk
12+
docker:
13+
- image: cimg/openjdk:11.0
14+
steps:
15+
# Checkout the code as the first step.
16+
- checkout
17+
# Use mvn clean and package as the standard maven build phase
18+
- run:
19+
name: Build
20+
command: mvn -B -DskipTests clean package
21+
# Then run your tests!
22+
- run:
23+
name: Test
24+
command: mvn test
25+
26+
workflows:
27+
# Below is the definition of your workflow.
28+
# Inside the workflow, you provide the jobs you want to run, e.g this workflow runs the build-and-test job above.
29+
# CircleCI will run this workflow on every commit.
30+
# For more details on extending your workflow, see the configuration docs: https://circleci.com/docs/2.0/configuration-reference/#workflows
31+
sample:
32+
jobs:
33+
- build-and-test

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,22 @@
11
# graphql-orchestrator-java
22

3+
[Builds](https://circleci.com/gh/intuit/graphql-orchestrator-java)
4+
35
### Overview
46

57
**GraphQL Orchestrator** is a library that exposes data from various data providers using a single unified GraphQL schema.
68
It aggregates and combines the schemas from these data providers and orchestrates the graphql queries to the appropriate services.
9+
10+
711
It uses the [graphql-java](https://github.com/graphql-java/graphql-java) library as the runtime execution engine on the unified schema.
812

913
### Getting Started
1014

11-
Requirement:
12-
* Java 8
13-
* Maven 3
14-
15-
1. Add this library to your project
16-
```
17-
<dependency>
18-
<groupId>com.intuit.graphql</groupId>
19-
<artifactId>graphql-orchestrator-java</artifactId>
20-
<version>${version}</version>
21-
</dependency>
22-
23-
2. Implement the [ServiceProvider](https://github.intuit.com/data-orchestration/stitching/blob/master/src/main/java/com/intuit/graphql/stitching/ServiceProvider.java) interface for the services you want to stitch.
24-
25-
3. Use the library in your code. Example:
26-
```
27-
// Build the stitcher with multiple services. Service interface in progress
28-
final GraphQLOrchestrator orchestrator = GraphQLOrchestrator.newOrchestrator()
29-
.instrumentations(Collections.emptyList())
30-
.services(Collections.emptyList()) // Implemented in Step 2
31-
.executionIdProvider(ExecutionIdProvider.DEFAULT_EXECUTION_ID_PROVIDER)
32-
.queryExecutionStrategy(new AsyncExecutionStrategy())
33-
.mutationExecutionStrategy(new AsyncExecutionStrategy())
34-
.build();
35-
36-
//execute the request
37-
orchestrator.execute(executionInput);
38-
39-
```
15+
Please take a look at [this example](https://intuit.github.io/graphql-orchestrator-java/usage/getting_started/)
4016

4117
### Documentation
4218

43-
Coming soon...
19+
Detailed [Documentation](https://intuit.github.io/graphql-orchestrator-java/) can be found here
4420

4521
### Contributing
4622

0 commit comments

Comments
 (0)