This project is still early in development. Therefore, until the first major version is released, non-backward changes may be introduced.

To clone and run this project, you'll need Git and, depending on your preference, Maven or Docker.

To clone the project run:

git clone --recursive https://github.com/ULisboa/ewp-node

Note the --recursive flag that is needed so the external dependencies configured as submodules are also cloned.

1. Import the project backend on an IDE (e.g. Intellij IDEA);

2. Execute the class pt.ulisboa.ewp.node.EwpNodeApplication

• Recommended: To use a development profile, pass a VM argument: -Dspring.profiles.active=dev

Refer to the Development documentation.

Run the command line:

docker build -t ulisboa/ewp-node .

Write into a docker-compose.yml file (check the section Docker Image Parameters for reference):

---
version: "2.1"
services:
  ewp-node:
    image: ulisboa/ewp-node
    container_name: ewp-node
    volumes:
      - <path to config folder>:/config
      - <path to logs folder>:/logs # Optional
      - <path to plugins folder>:/plugins # Optional
    ports:
      - 8080:8080
    healthcheck:
      test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "--no-check-certificate", "http://localhost:8080/rest/healthcheck"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 60s
    restart: unless-stopped

Then run on the folder containing that file:

docker-compose up -d

Notes:

• If SSL is enabled then every reference in the docker-compose.yml file to port 8080 must be changed accordingly, including changing "http" to "https" on the healthcheck test command;
• This configuration can be adapted to run on Docker Swarm.

Container images are configured using parameters passed at runtime. These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 80:8080 would expose port 8080 from inside the container to be accessible from the host's IP on port 80 outside the container.

When the project is running, the endpoint http://localhost:8080/swagger-ui.html will provide an interface to the APIs automatic documentation.

More documentation is available on the folder docs/.

This project is licensed under the terms of the MIT license.