Skip to content
Snippets Groups Projects
Commit 767f0662 authored by Andreas Kunz's avatar Andreas Kunz
Browse files

Add documentation

parent ef4b155e
Branches
No related tags found
No related merge requests found
......@@ -3,6 +3,9 @@
Collection of database clients for demo and training purposes.
Please feed back improvements and fixes via pull request.
## Documentation
[Getting started with the project](doc/setup/gradle-ide.md)
## License
Copyright 2022 OST - Ostschweizer Fachhochschule (kuan)
......
doc/blob/powerShellGradle.png

20.7 KiB

doc/blob/projectOpenedInIDEA.png

129 KiB

doc/blob/runGradle.png

33 KiB

# Getting started
## Run a build with gradle
In the project root, there is a **gradlew** shell script. The **gradlew.bat** is for Windows.
The script runs the gradle wrapper program, which is included in the project. So there
is no local gradle installation needed. To run the wrapper, a Java Development Kit
version 8 or higher is needed. The installed version can be checked by running
`java --version` in your shell.
A build is run when the script is run either in the PowerShell or bash.
The picture below shows a run in the Windows PowerShell.
![powerShellGradle.png](../blob/powerShellGradle.png "powerShellGradle.png")
## Open the project in an IDE
The project can be opened in any IDE. It makes sense to choose an IDE which supports Gradle.
IntelliJ IDEA Community is recommended. It can be downloaded using the following link:
*https://www.jetbrains.com/idea/download*
![projectOpenedInIDEA.png](../blob/projectOpenedInIDEA.png "projectOpenedInIDEA.png")
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment