README.md 1.51 KB
Newer Older
Jyrgen Hannus's avatar
Jyrgen Hannus committed
1
# Opendata service
Enriko Käsper's avatar
Enriko Käsper committed
2

Jyrgen Hannus's avatar
Jyrgen Hannus committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
Opendata service is a microservice which provides publicly accessible data.

## Features

Opendata service is a Spring Boot application providing the following functionality:

* retrieval of public data

## Requirements

* [OpenJDK 11](https://openjdk.java.net/projects/jdk/11/)
* [Rabbit MQ](https://www.rabbitmq.com/)
* [PostgreSQL](https://www.postgresql.org/)

17
See [how to run required dependencies](../../docs/blob/master/run-requirements.md).
Jyrgen Hannus's avatar
Jyrgen Hannus committed
18 19 20

Opendata service depends on other TeIS libraries:

21 22 23
* [TeIS Gradle plugin](../../teis-gradle-plugin)
* [TeIS public commons libraries](../../commons-public)
* [TeIS commons libraries](../../commons)
Jyrgen Hannus's avatar
Jyrgen Hannus committed
24 25 26 27 28 29 30 31
* [TeIS opendata API gateway library](../opendata-api-gateway)

## Run application

Spring Boot project can be run directly from [OpenDataServiceApp.main()](service/src/main/java/ee/sm/ti/teis/OpenDataServiceApp.java) 
method or via executable jar file. More info on running Spring applications: 
[running your application.](https://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-running-your-application.html)

32
Visit [how to run application](../../docs/blob/master/run-application.md).
Jyrgen Hannus's avatar
Jyrgen Hannus committed
33 34

## Build and configure
35
Visit [how to build](../../docs/blob/master/build-configure.md) for more info.
Jyrgen Hannus's avatar
Jyrgen Hannus committed
36 37

## Default profiles
38
Visit [environment profiles](../../docs/blob/master/default-profiles.md) for more info.
Jyrgen Hannus's avatar
Jyrgen Hannus committed
39 40 41 42 43 44 45 46

## Tests

Run [integration](service/src/integTest) and [unit tests](service/src/test) via IDE or with Gradle in command line:

```jshelllanguage
./gradlew test
```