Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Java
  • Maven
  • Here we describe the setup in IntelliJ, but you can use an IDE of your choice
  • Docker / Docker Compose

Development Environment

In this setup we will start the backend, connect, and the processors in your IDE. The UI and all the other services run in docker.

...

  1. Clone Installer [Link]

    Code Block
    languagebash
    titlePrepare Installer
    # SSH
    git clone git@github.com:apache/incubator-streampipes.git
    
    # HTTPS
    git clone https://github.com/apache/incubator-streampipes.git 
    
    # switch to development branch
    git checkout dev


  2. Open CLI directory

    Code Block
    languagebash
    titlePrepare Installer
    cd installer
    cd cli


  3. Configure StreamPipes for backend development

    Code Block
    languagebash
    titlePrepare Installer
    ./streampipes env --set backend
    # Updates the file 'system'. All StreamPipes services required for development are selected


  4. Start third party services (e.g. CouchDB, Kafka, ... in docker)

    Code Block
    languagebash
    titlePrepare Installer
    ./streampipes up -d


...

  1. Add a new application with the following Run/Debug Configurations
  2. Main class: org.apache.streampipes.service.backendcore.StreamPipesBackendApplication
  3. Use classpath of module: streampipes-service-backendcore
  4. Environment variables: streampipes-backendservice-core/development/env
  5. Apply, OK & Start the application
  6. Navigate to "http://localhost:8030/streampipes-backend/" to see if the backend is running. You should see the following message:

Instead of the development file, we also provide a startup configuration for IntelliJ under development/runConfigurations, which should be added automatically to the project.