Skip to content

Wrapper providing RESTful services for the qrapids-forecast library functionality

License

Notifications You must be signed in to change notification settings

q-rapids/qrapids-forecast-rest

Repository files navigation

qrapids-forecast-rest

Wrapper to provide the qrapids-forecast library functionality as RESTful services

This component has been created as a result of the Q-Rapids project funded by the European Union Horizon 2020 Research and Innovation programme under grant agreement No 732253.

Main Functionality

This component wraps qrapids-forecast library in order to access it as a RESTful service.

Technologies

Property Description
Type of component RESTful Service
Build .war
Programming language Java
Frameworks Spring Boot, Gradle
External libraries qrapids-forecast

How to build

This is a Gradle project. You can use any IDE that supports Gradle to build it, or alternatively you can use the command line using the Gradle wrapper with the command gradlew if you don't have Gradle installed on your machine or with the command gradle if you do, followed by the task war.

# Example: using Gradle wrapper to build with dependencies
cd qrapids-forecast-rest
gradlew war

After the build is done the WAR file can be found at the build/libs directory

How to deploy

Available in the Wiki

Documentation

You can find the user documentation in the repository and the technical documentation of the RESTful API here.

Contributing

You can find guidelines to contribute to the project in the Q-Rapids repository.

Licensing

Software licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact

For problems regarding this component, please open an issue in the issues section. You can find some guidelines for submitting issues in the Q-Rapids repository.

For general information, please use the Q-Rapids project website.