81 lines
2.4 KiB
Markdown
81 lines
2.4 KiB
Markdown
# tracker
|
||
|
||
# SETUP
|
||
The connection parameters can be set in the file src/main/resources/application.properties.
|
||
|
||
The MYSQL setup script can be found in SQL, alternatively you can use hibernate to create the tables.
|
||
|
||
Fill in your parameters for 'password', 'username', 'host' and 'db' or delete them all and have hibernate create tables for you.
|
||
|
||
# Postman collection
|
||
Postman collection can be found in postman folder
|
||
|
||
# Documentatie
|
||
Documentatie is te vinden op <https://docs.nunnink.dev/tracker-api> en <https://docs.nunnink.dev/demo_ontwerp.html>.
|
||
|
||
# Introduction
|
||
This project uses Quarkus, the Supersonic Subatomic Java Framework.
|
||
|
||
If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>.
|
||
|
||
## Running the application in dev mode
|
||
|
||
You can run your application in dev mode that enables live coding using:
|
||
|
||
```shell script
|
||
./mvnw compile quarkus:dev
|
||
```
|
||
|
||
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>.
|
||
|
||
## Packaging and running the application
|
||
|
||
The application can be packaged using:
|
||
|
||
```shell script
|
||
./mvnw package
|
||
```
|
||
|
||
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
|
||
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
|
||
|
||
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
|
||
|
||
If you want to build an _über-jar_, execute the following command:
|
||
|
||
```shell script
|
||
./mvnw package -Dquarkus.package.jar.type=uber-jar
|
||
```
|
||
|
||
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
|
||
|
||
## Creating a native executable
|
||
|
||
You can create a native executable using:
|
||
|
||
```shell script
|
||
./mvnw package -Dnative
|
||
```
|
||
|
||
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
|
||
|
||
```shell script
|
||
./mvnw package -Dnative -Dquarkus.native.container-build=true
|
||
```
|
||
|
||
You can then execute your native executable with: `./target/tracker-1.0.0-SNAPSHOT-runner`
|
||
|
||
If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>.
|
||
|
||
## Related Guides
|
||
|
||
- SmallRye GraphQL ([guide](https://quarkus.io/guides/smallrye-graphql)): Create GraphQL Endpoints using the code-first approach from MicroProfile GraphQL
|
||
|
||
## Provided Code
|
||
|
||
### SmallRye GraphQL
|
||
|
||
Start coding with this Hello GraphQL Query
|
||
|
||
[Related guide section...](https://quarkus.io/guides/smallrye-graphql)
|