Docs
Search…
Local Module Testing
Here you can learn how to test your modules locally, before pushing them to APEER.
The APEER module debugger is still under development and may still contain errors. Also, it does not work on Linux, yet. We welcome your feedback - either per mail ([email protected]) or by opening an issue in our github account (https://github.com/apeer-micro/apeer-module-debugger/issues).

Docker Installation

You need to install docker first, before installing the APEER module debugger.
Windows
Mac
Please follow the instructions here to install docker on your machine.
Once the installation has finished, you will be prompted with a pop-up window. On Windows, you manually need to allow access to your drive. Go to Settings -> Shared Drives and tick the box next to your C drive.
Please follow the instructions here to install docker on your machine.

Debugger Installation

You can find the APEER module debugger in our GitHub repository. Download the .exe file for Windows or the .dmg for Mac.

How to Use

Once you have clicked on the application shortcut, you will be prompted to choose a folder containing a module.
Choose the folder of the module you would like to test, like, for instance the "hello world" module.
Click on "Build" to automatically trigger the local build of your module.
Switch to run regime by clicking on the arrow next to "Run" on the top right.
Choose the inputs for your module (currently only files, numbers and strings are supported). The selected input files will be copied to a new "input" folder in your module folder and the outputs to the new "output" folder, respectively.
Click on the "Run" button to execute your module.
You will see the module logs and receive a notification as soon as the module finished successfully.
Click on the "Open Output Folder" link to check your results.

Features backlog

  • Support of more input types
  • Add input restrictions (e.g. users should not be able to input values that are out of range)
  • Improvements for UI
  • Better error handling
You can find the APEER module debugger in our GitHub repository.

Clone the repository

You couldn't find all the information you need? Contact us!

If you need help, just check out our FAQ. For any further questions please contact us at [email protected] or have a look at How-tos section in our blog or follow us on Twitter to stay up to date.
Last modified 2yr ago