-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Guy Davenport
committed
May 28, 2024
1 parent
805b2d0
commit a2c9992
Showing
3 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# BrAPI Schema Tools | ||
|
||
BrAPI Schema Tools generates and view the BrAPI Specification | ||
|
||
Here you find the following modules | ||
|
||
* [application](application/README.md) - A spring application that allow you to view the generated specification | ||
* buildSrc- Defines the plugins use by the gradle | ||
* [cli](cli/README.md) - The command line tool that makes use of the core module | ||
* [core](core/README.md) - The core schema tools |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# BrAPI Schema Tools - Spring Application | ||
|
||
The module contains a deployable Spring application. However, its main use is to view the BrAPI Specification locally | ||
|
||
You need to generate the OpenAPI specification and GraphQL schema and place these in the | ||
[/src/main/resources/openapi/schema.graphqls] and /src/main/resources/openapi/brapi_openapi.json | ||
files respectively. See the [CLI module](../cli/README.md) for details. | ||
|
||
To run the application use the following commands | ||
|
||
In windows | ||
|
||
```powershell | ||
./gradlew bootRun | ||
``` | ||
|
||
In Linux or MacOS | ||
|
||
```shell | ||
./gradle bootRun | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,56 @@ | ||
# BrAPI Schema Tools - Core Classes | ||
|
||
Core Java classes for parsing the BrAPI Schema | ||
|
||
Use gradle to build, test and publish | ||
|
||
|
||
## In windows | ||
|
||
To make a clean build use | ||
```powershell | ||
./gradlew clean build | ||
``` | ||
|
||
To make a clean build and test use | ||
```powershell | ||
./gradlew clean test | ||
``` | ||
|
||
To make a clean build and publish locally use | ||
```powershell | ||
./gradlew clean publishToMavenLcoal | ||
``` | ||
|
||
To make a clean build and release, you will need some secrets. | ||
It is not recommend to this from here, | ||
let the CI on GitHub handle this. | ||
|
||
```powershell | ||
./gradlew clean test publish | ||
``` | ||
|
||
## In Linux or MacOS | ||
|
||
To make a clean build use | ||
```shell | ||
./gradlew clean build | ||
``` | ||
|
||
To make a clean build and test use | ||
```shell | ||
./gradlew clean test | ||
``` | ||
|
||
To make a clean build and publish locally use | ||
```shell | ||
./gradlew clean publishToMavenLcoal | ||
``` | ||
|
||
To make a clean build and release, you will need some secrets. | ||
It is not recommend to this from here, | ||
let the CI on GitHub handle this. | ||
|
||
```shell | ||
./gradlew clean test publish | ||
``` |