👩💻Contributing

Setup from the ground up 🌱
Scalability Branch
1. Installation of MongoDB Community Edition
Follow the installation instructions depending on your OS MongoDB Installation.
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.
2. Installation of MongoDB database tools
Follow the installation instructions depending on your OS MongoDB Database Tools Installation.
Install MongoDB Database Tools on Windows
Install with the MSI Installer.
1. Installation of Nvm
2. Installation of npm/node.js
nvm install lts
nvm use lts
3. Clone the repository
We are currently using develop as our main branch.
git clone -b develop https://github.com/MEDomics-UdeS/MEDomicsLab.git
4. Setup server side (Go)
4.1 Installation of Go
Download the latest stable release of Go from the official website: https://golang.org/dl/
Follow the installation instructions for your operating system.
4.2 Setup of environment
Execute these commands in a cmd prompt:
setx GOPATH %USERPROFILE%\go
setx PATH "%PATH%;C:\Go\bin"
After, close all your terminals because these commands will take effects on the initialisation of any terminal
4.3 Verify installation
Open a new terminal
Run the command
go version
If Go is installed correctly, you should see the version number printed to the console.
4.4 Setup for the application
Open a new command prompt and go to the
<repo path>/go_server
directory.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!
5. Init submodules
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
6. Start the electron app !
cd <.../MEDomicsLab>
npm install
npm run dev
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.1
nvm 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
Modify startup settings
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
}
To Test the Production Build
Build the Electron app and Run the built version
npm run build:win # build and package the application
.\build\dist\win-unpacked\MEDomicsLab.exe # Run the executable of the built version
The built app will be located in the
build/dist
folder
Last updated