eclipsefdn-working-group-api

This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Getting Started

Requirements

• Docker
• mvn
• make
• yarn
• Java 11 >

Setup

Before running the application, the initial setup should be observed. The initial setup of this server can be started by running the command make setup which will instantiate the secrets file and environment hidden file. To finish the setup of the environment file, open it and add values to the missing fields before starting docker for this project. The missing fields are primarily passwords for the various services running in docker for the project. Set them to some values and save the file. Once finished you can run the docker-compose command for this project successfully. If you need to start MariaDB (not using a shared volume) you can use docker-compose --profile full up to start MariaDB along with other services.

Additionally, some of the values in the .env file will need to be set into the secret.properties files in ./config/application/secret.properties and ./config/foundationdb/secret.properties. The value for WGAPI_MYSQL_PASSWORD will need to be set as the value for the quarkus.datasource.password property in both files. This will give the applications access to make changes to the databases.

Once the stack is running, navigate to http://localhost:8080 and log into Keycloak using the credentials set in the .env file. Upon logging in in the top left corner, if the text says Master, then hover over the text and select Foundation in the pop up that appears below the text. This switches your realm to the one configured at boot time by the embedded configuration files. In the left hand menu, select Clients and open the foundation client by clicking on the name of the client. Once here, navigate to the Credentials tab and regenerate the secret. That text will be the value of the quarkus.oidc.credentials.client-secret.value property in the ./config/foundationdb/secret.properties file. Do the same thing for the working_groups_api client, instead setting the value of quarkus.oidc.credentials.secret property in the ./config/secret.properties file.

Build and Start Server

make compile-start

Live-coding Dev Mode

make dev-start

Generate Spec

make compile-test-resources

Running Tests

mvn test

Render a Live UI Preview of the API Spec

make start-spec

Packaging and running the application

The application can be packaged using:

make compile

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:

mvn 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:

mvn package -Pnative

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

mvn package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/eclipsefdn-working-group-api-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

• RESTEasy Classic (guide): REST endpoint framework implementing JAX-RS and more

Provided Code

RESTEasy JAX-RS

Easily start your RESTful Web Services

Related guide section...

Contributing

1. Fork the eclipsefdn-working-groups-api repository
2. Clone repository git clone https://gitlab.eclipse.org/[your_eclipsefdn_username]/eclipsefdn-working-groups-api.git
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -m 'Add some feature' -s
5. Push feature branch: git push origin my-new-feature
6. Submit a merge request

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0