Build from source
This page explains how to start the development services, then build and run the OpenAEV backend and frontend. Run the commands from the root of the repository unless stated otherwise.
Clone the OpenAEV repository
Obtain a clone of the main OpenAEV repository and navigate to it:
Backend
Configuring
Development uses a dev Spring profile. Create your local configuration from the example file:
cp ./openaev-api/src/main/resources/application-dev.properties.example \
./openaev-api/src/main/resources/application-dev.properties
application-dev.properties is gitignored. Generate a UUID for openaev.admin.token before the
first start.
Tip
The example enables optional integrations (SAML, Caldera, IMAP, SMS, and others) that need
external credentials. If you do not have those accounts, set the corresponding *.enable
flags to false and set openaev.listener.smtp.enabled=false.
host.docker.internal for RabbitMQ
The example sets openaev.rabbitmq.hostname=host.docker.internal so Dockerized Injectors can reach
RabbitMQ. This name does not resolve from the host, so add this entry to your hosts file if it is missing
(/etc/hosts on Linux and macOS, C:\Windows\System32\drivers\etc\hosts on Windows, where Docker
Desktop usually adds it already):
Use localhost instead if you do not run Injectors in Docker. Keep the value on its own
line with no trailing comment — Java properties treat # ... on the same line as part of
the hostname and RabbitMQ will fail to resolve it.
Start the development services
Preconfigured containers for the support services (PostgreSQL, Silo, RabbitMQ, Elasticsearch)
live in ./openaev-dev. Copy the example environment file, then start the four required services:
cd ./openaev-dev
cp .env.example .env
docker compose up -d openaev-dev-pgsql openaev-dev-minio openaev-dev-elasticsearch openaev-dev-rabbitmq
cd ..
| Service | Port | Description |
|---|---|---|
| PostgreSQL | 5432 | Database |
| Silo | 10000, 10001 | S3-compatible object storage |
| Elasticsearch | 9200, 9300 | Search engine |
| RabbitMQ | 5672, 15672 | Message broker (guest / guest) |
Warning
Ensure these ports are not already in use on your machine before starting the services.
The values in .env.example work for local development. See ./openaev-dev/README.md for optional
services (pgAdmin, Kibana, OpenSearch).
The example application-dev.properties already points to these services (PostgreSQL, Silo, RabbitMQ,
Elasticsearch). All settings are listed in the Configuration documentation.
Building and running
Maven is used for package management and building the main server binary.
On a fresh clone, install all modules first, then start the API with the dev
Spring profile:
The backend listens on port 8080.
Frontend
Run the commands in this section from ./openaev-front:
Building
Enable Corepack (Yarn 4 is pinned in package.json), then install dependencies:
If yarn install fails during the link step with ENOENT while cloning a node_modules
path, see yarnpkg/berry#3214.
Running
Execute yarn start to start a frontend locally:
IntelliJ IDEA run configurations
The repository provides IntelliJ IDEA run configurations in ./openaev-dev. After you open the
repository root in IDEA, Backend start and Frontend start show up in the Run widget.
What's next?
- Platform development -- Day-to-day backend and frontend workflow
- Database migrations -- Create Flyway migrations
- Prerequisites macOS -- macOS toolchain setup
- Prerequisites Ubuntu -- Linux toolchain setup
- Prerequisites Windows -- Windows toolchain setup