Skip to content

Commit f57c29a

Browse files
author
Laurent Gougeon
committed
Added Developers section with setup instructions for VS Code & Eclipse.
1 parent 55cee68 commit f57c29a

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

+46
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Data Acquisition and Data Dissemination are active services initiated by OpenECP
1616
- [Object Storage](#object-storage)
1717
- [Additional Features](#additional-features)
1818
- [Getting Started](#getting-started)
19+
- [For Developers](#for-developers)
1920
- [Deployment](#deployment)
2021
- [Concepts for Users](#concepts-for-users)
2122
- [Support Materials](#support-materials)
@@ -205,6 +206,51 @@ To clean the logs and data:
205206
make clean
206207
```
207208

209+
## For Developers
210+
211+
OpenECPDS includes configuration files for both Visual Studio Code and Eclipse, so you can choose the development environment you are most comfortable with. Simply select your preferred IDE, and you will find ready-to-use settings tailored to streamline your work with OpenECPDS.
212+
213+
After completing the following steps, it will be possible to start and debug the OpenECPDS Java program within the IDE. An instance of the OpenECPDS database is required for the Master service to function. To set this up, build the application as outlined in the Getting Started section, then start only the database component with the following command:
214+
215+
```
216+
make up container=database
217+
```
218+
219+
This command will start only the database service, while the other services can be launched directly from the IDE.
220+
221+
### Visual Studio Code
222+
223+
When working with OpenECPDS in Visual Studio Code, the **Dev Containers extension** is required and will automatically detect the presence of a `.devcontainer` directory within the project folder. This directory contains key configuration files, such as `devcontainer.json` and a `Dockerfile`, which collectively define the development environment for OpenECPDS.
224+
225+
Before opening the project, make sure to edit `.devcontainer/devcontainer.json` to update the DOCKER_HOST_OS environment parameter according to your Docker host operating system (the default is set to Darwin for macOS).
226+
227+
Once you open the OpenECPDS folder, VS Code will prompt you to reopen the project within a container: **Reopen in Container**. If you choose to proceed, VS Code will use the `Dockerfile` to build the container image and launch a development container. This container will be preconfigured with all the tools, dependencies, and settings specified in `devcontainer.json`, ensuring a consistent and fully-equipped development environment right from the start.
228+
229+
Once the development container is set up, open a terminal within it to begin building as described in the Getting Started section.
230+
231+
For more information on working with development containers in Visual Studio Code, please visit the [Microsoft website](https://code.visualstudio.com/docs/devcontainers/containers).
232+
233+
To access the Debug and Run configurations:
234+
235+
- Open the **Command Palette** by pressing Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac).
236+
- Type **Run and Debug** in the **Command Palette** to find the **Run and Debug** view.
237+
- Select **Run and Debug** in the sidebar or access it through the **Debug icon** in the Activity Bar on the left side of VS Code.
238+
239+
This view displays the available Run and Debug configurations, including those defined for the OpenECPDS Master, Mover, and Monitor components.
240+
241+
### Eclipse
242+
243+
To open the OpenECPDS project in Eclipse:
244+
245+
- Go to **File > Import...**
246+
- In the import dialog, select **Existing Maven Projects** under the **Maven category** and click **Next**.
247+
- Browse to the location of your OpenECPDS project folder on your system and select it. Eclipse will automatically detect the project files.
248+
- Once the project is detected, click **Finish** to complete the import. Eclipse will set up the project and download dependencies.
249+
250+
After completing these steps, the OpenECPDS project should be ready to work with in Eclipse, with access to any required dependencies and configurations.
251+
252+
Preconfigured **Debug** and **Run** options are available for key components: **Master**, **Mover**, and **Monitor**. These configurations can be accessed under **Run > Run Configurations...** and **Run > Debug Configurations...**
253+
208254
## Deployment
209255

210256
If you have successfully built the OpenECPDS containers and enabled Kubernetes in Docker, navigate to the following directory where a [Makefile](deploy/kubernetes/Makefile) is available:

0 commit comments

Comments
 (0)