Skip to content

✨ Getting Started

Overview

This guide will help you set up Etendo, including both the Etendo Classic functionalities and Etendo RX, our reactive platform capable of executing microservices with database interaction and asynchronous actions.

Requirements

  1. Install Etendo Classic. For this, follow the Etendo Classic installation guide.
  2. Install the Platform Extensions Bundle.
  3. This project depends on the following tools:

Dockerized Services

In the platform bundle, you can find the Dockerized Services module, which provides the necessary architecture to distribute infrastructure. In this case, in this bundle, the module Etendo RX is also included and, to launch the Services distributed in it, a certain configuration is needed. In the gradle.properties file, add the following variable:

gradle.properties
docker_com.etendoerp.etendorx=true

Info

For more information about how to handle Etendo Dockerizations, visit Docker Management.

Tomcat and PostgresSQL Dockerized (Optional)

It is also possible to run the dockerized PostgreSQL service and Tomcat service, optionally adding the Platform Extensions Bundle and the following configuration variables:

gradle.properties
docker_com.etendoerp.tomcat=true
docker_com.etendoerp.docker_db=true

If you want to debug Tomcat locally with IntelliJ, visit Tomcat Dockerized Service.

Then, to effectively run the services, it is necessary to execute the command in the terminal:

Terminal
./gradlew resources.up

Here, all the services and their respective logs can be seen running using lazydocker or Docker Desktop for a simple and fast container management.

Docker Services

By default, the following services should be up and running:

  • Config
  • Auth
  • Edge
  • Das

Success

You have successfully set up the Etendo RX services. For more information, visit Projections and Mappings and Creating a New Microservice page in the developer guide section.