High-Level Architecture of the Main Framework Used in the Application
The map below illustrates the organization of files, modules, databases, and the Frontend-Backend connection within MEDomicsLab. This visual guide is designed to support new contributors in understanding the application’s structure, streamlining the integration of new features, and aiding efficient navigation through the codebase.
{% embed url="https://miro.com/app/embed/uXjVKiE9qtw=/?embedId=366443778390&frameId=3458764605680580664&pres=1" %} MEDomicsLab detailed architecture {% endembed %}
{% hint style="info" %} Go visit our github develop branch ! {% endhint %}
{% hint style="info" %} The requirements in this section are only necessary if you want to work from the scalability branch. {% endhint %}
Follow the installation instructions depending on your OS MongoDB Installation.
{% tabs %} {% tab title="Windows" %} Install MongoDB on Windows
- Do not install MongoDB as a service.
- You do not have to install MongoDB compass.
- You do not have to install mongosh.
- Do not forget to add MongoDB binaries to the System PATH. {% endtab %}
{% tab title="Linux" %} Install MongoDB on Linux (Ubuntu)
- Install the latest version of MongoDB {% endtab %}
{% tab title="Mac" %} Install MongoDB on Mac {% endtab %} {% endtabs %}
Follow the installation instructions depending on your OS MongoDB Database Tools Installation.
{% tabs %} {% tab title="Windows" %} Install MongoDB Database Tools on Windows
- Install with the MSI Installer. {% endtab %}
{% tab title="Linux" %} Install MongoDB Database Tools on Linux
- Install with the DEB package. {% endtab %}
{% tab title="Mac" %} Install MongoDB Database Tools on Mac
- Install with Homebrew. {% endtab %} {% endtabs %}
nvm install lts
nvm use lts
{% hint style="warning" %} We are currently using develop as our main branch. {% endhint %}
{% tabs %} {% tab title="HTTPS" %}
git clone -b develop https://github.com/MEDomics-UdeS/MEDomicsLab.git
{% endtab %}
{% tab title="SSH" %}
git clone -b develop git@github.com:MEDomics-UdeS/MEDomicsLab.git
{% endtab %} {% endtabs %}
- Download the latest stable release of Go from the official website: https://golang.org/dl/
- Follow the installation instructions for your operating system.
{% tabs %} {% tab title="Windows" %} Execute these commands in a cmd prompt:
setx GOPATH %USERPROFILE%\go
setx PATH "%PATH%;C:\Go\bin"
{% endtab %}
{% tab title="Linux and Mac" %}
Execute these commands in a terminal:
echo 'export PATH=$PATH:/usr/local/go/bin' >> $HOME/.bashrc
echo 'export GOPATH=$HOME/go' >> $HOME/.bashrc
echo 'export PATH=$PATH:$GOPATH/bin' >> $HOME/.bashrc
{% endtab %} {% endtabs %}
After, close all your terminals because these commands will take effects on the initialisation of any terminal
- Open a new terminal
- Run the command
go version - If Go is installed correctly, you should see the version number printed to the console.
- Open a new command prompt and go to the
<repo path>/go_serverdirectory. - Run the command
go run main.go(on first time, it should download requiered libraries and lunch the server) - you can terminate the process by pressing
CTRL + C - Then build the app by running
go build main.go(It should create an executable file -> that file will be run by the client side javascript so modification to .go files must be followed by a rebuild) Congratulations, you're now ready to start developing Go applications!
cd <.../MEDomicsLab/>
git submodule init
git submodule update --init --recursive --remote
cd pythonCode/submodules/MEDimage
git checkout dev_lab
cd ../MEDprofiles
git checkout fusion_MEDomicsLab
{% code fullWidth="false" %}
cd <.../MEDomicsLab>
npm install
npm run dev
{% endcode %}
{% hint style="warning" %}
On Windows, if you encounter error messages when running npm install,follow the steps here to solve the issue : https://github.com/nodejs/node-gyp#on-windows.
- You will need to install the Visual Studio Build Tools (select the C++ build environment)
- Install Python3.11 from here
- Use node version v18.16.1. Run:
nvm install v18.16.1nvm use v18.16.1
- Set the Python3.11 :
$Env:npm_config_python="C:\path\to\python.exe" # PowerShell
- Run
npm install -g node-gyp - Run again
npm install
{% endhint %}
{% hint style="info" %}
- Go to file
medomics.dev.js - Here is a description of the Object:
const config = {
// If true, the server will be run automatically when the app is launched
runServerAutomatically: true,
// If true, use the react dev tools
useReactDevTools: false,
// the default port to use for the server, be sure that no programs use it by default
defaultPort: 5000,
// Either "FIX" or "AVAILABLE" (case sensitive)
// FIX -> if defaultPort is used, force terminate and use defaultPort
// AVAILABLE -> if defaultPort is used, iterate to find next available port
portFindingMethod: PORT_FINDING_METHOD.FIX
}{% endhint %}
{% tabs %} {% tab title="Windows" %}
npm run build:win # build and package the application
.\build\dist\win-unpacked\MEDomicsLab.exe # Run the executable of the built version
{% endtab %}
{% tab title="Linux" %}
npm run build:linux # build and package the application
bash build/dist/linux-unpacked/medapp # Run the executable of the built version
{% endtab %}
{% tab title="Mac" %}
npm run build:mac # build and package the application
bash build/dist/mac-arm64/MEDomicsLab.app/Contents/MacOS/MEDomicsLab # Run the executable of the built version
{% endtab %} {% endtabs %}
The built app will be located in the
build/distfolder