Getting started
Last updated
Was this helpful?
Last updated
Was this helpful?
Version: ≥5.0.x
Welcome to EDDI!
This article will help you to get started with EDDI.
You have two options to run EDDI, The most convenient way is to run EDDI with Docker. Alternatively, of course, you can run EDDI also from the source by checking out the git repository and build the project with maven using either the mvn
command line or an IDE such as eclipse.
There are two ways to use Docker
with EDDI, either with docker-compose
or launch the container manually.
Prerequisite: You need an up and running Docker
environment. (For references, see: )
Checkout
the docker-compose
file from Github
:
Run Docker Command:
Create a shared network
Start a MongoDB
instance using the MongoDB
Docker
image:
Start EDDI :
Java 21
Maven 3.8.4
MongoDB > 4.0
Setup a local mongodb (> v4.0)
On a terminal, under project root folder, run the following command:
Note: If running locally inside an IDE you need lombok to be enabled (otherwise you will get compile errors complaining about missing constructors). Either download as plugin (e.g. inside Intellij) or follow instructions here [https://projectlombok.org/](https://projectlombok.org/
For production, launch standalone mongodb and then start an eddi instance as defined in the docker-compose file
For development, use
For integration testing run
or
Important for eclipse users: If you are planning to browse and build EDDI's code from eclipse, you must take in consideration that EDDI uses project Lombok, so you must add it to eclipse classpath, this can be done easily by executing this jar:
.m2\repository\org\projectlombok\lombok\1.16.26\lombok-1.16.26.jar
Go to Browser -->