Toxicity-annotator

Based on the TTLab-Annotator

Frontend

The frontend is written using React and Typescript. It offers users a simple way to get game data and annotate each message and the game itself as toxic or not.

Backend

You can find the backend under the java directory.

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 docker compose

First build the application

./mvn clean package

Then run

docker-compose up

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./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:

./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:

./mvnw package -Dquarkus.package.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:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/ttlab-annotator-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

• MongoDB with Panache (guide): Simplify your persistence code for MongoDB via the active record or the repository pattern
• Hibernate Validator (guide): Validate object properties (field, getter) and method parameters for your beans (REST, CDI, Jakarta Persistence)
• SmallRye OpenAPI (guide): Document your REST APIs with OpenAPI - comes with Swagger UI
• Elytron Security Properties File (guide): Secure your applications using properties files
• SmallRye Health (guide): Monitor service health
• SmallRye Metrics (guide): Expose metrics for your services