Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 2.28 KB

getting_started.md

File metadata and controls

93 lines (61 loc) · 2.28 KB

Getting Started

This guide will help you set up Eventeum on your local machine for development and testing.

Prerequisites

Before running Eventeum, ensure you have the following installed:

  • Java 21
  • Maven
  • Docker & Docker Compose (for containerized deployment)

Building the Project

  1. Clone the repository and navigate to the project directory:

    git clone https://github.com/IoBuilders/eventeum
cd eventeum

  2. Compile, test, and package the project using Maven:

    mvn clean package

Running Eventeum

Running with Docker Compose (Recommended)

Eventeum provides a docker-compose setup that includes all required dependencies. There are two ways to run it:

Option 1: Using the setup script

  1. Navigate to the server directory:

    cd server

  2. Make the setup script executable and run it with the desired configurations:

    chmod +x setup_env.sh
./setup_env.sh <broker> <database> <blockchain>

    This script automatically configures and starts the required services without needing to run docker-compose manually.

Option 2: Manually building Eventeum and running Docker Compose

  1. Navigate to the server directory:

    cd server

  2. Build Eventeum's Docker image and start it using docker-compose with the desired profiles:

    docker-compose --profile <profile-name> --profile <profile-name> up --build

    Replace <profile-name> with the desired profile:

    • kafka → Uses Kafka for messaging
    • rabbitmq → Uses RabbitMQ for messaging
    • mongodb → Uses Mongo for database
    • postgresql → Uses Postgres for database
    • eventeum → Use Eventeum as a Docker service with a pre-built image

  3. To stop the services, use:

    docker-compose down

Running as a JAR File (Alternative)

If you prefer to run Eventeum manually and have an existing instance of MongoDB, Kafka, Zookeeper, and an Ethereum node, you can start it as a JAR file:

cd server
SPRING_PROFILES_ACTIVE=kafka,mongodb,ethereum java -jar target/eventeum-server.jar

Next Steps