Open Elements Open Data Server

This is the open data server of Open Elements. The server provides data by REST endpoints.

Public endpoint of the server: https://open-elements-open-data.koyeb.app/swagger-ui/index.html

Start the application

A .env file is needed to provide a GitHub API Token. The .env.sample file is provided as an example.

The project is a Spring Boot based webservice. To run it, you need to have Java 21 installed.

To run the project, you can use the following command:

./mvnw spring-boot:run

http://localhost:8080/swagger-ui/index.html <- Swagger UI

http://localhost:8080/v3/api-docs.yaml <- OpenAPI 3.0 doc

Build the application

To build the application, you can use the following command:

./mvnw clean verify

This will build the application and run the tests.

Run the application in a Docker container

To run the application in a Docker container, you need to build the Docker image and run the container. The Docker image is built by the following command that need to be executed in the root directory of the project:

docker build -t backend-template .

This will build the Docker image with the name backend-template. To run the Docker container, execute the following command:

docker run -d -p 8080:8080 backend-template

This will start the Docker container and the application will be available at http://localhost:8080.

Deployment

Today Open Elements uses koyeb to deploy the frontend and backend services.