Developer Documentation

Build dependencies

conda

You can install conda as part of a Miniforge installer.
conda pack and conda lock to bundle JupyterLab Desktop Server into the standalone application and to create lock files. You can install them using:
```
conda install -c conda-forge conda-pack conda-lock
```
nodejs

You can install from https://nodejs.org/en/download/ or run:
```
conda install -c conda-forge nodejs
```
yarn

Install using
```
npm install --global yarn
```

JupyterLab Desktop bundles JupyterLab front-end and a conda environment as JupyterLab Desktop Server as its backend into an Electron application.

<platform>: osx-64, osx-arm64, linux or win

Get the project source code

git clone https://github.com/jupyterlab/jupyterlab-desktop.git

Install dependencies and build JupyterLab Desktop
```
yarn
yarn build
```
Create the JupyterLab Desktop Server installer using
```
yarn create_env_installer:<platform>
```
Installer will be created in env_installer/jlab_server.tar.gz and will be available for use in env_installer/jlab_server.
Now you can launch the JupyterLab Desktop locally using:
```
yarn start
```
If JupyterLab Desktop does not find a compatible Python environment configured, it will prompt for installation using JupyterLab Desktop Server installer or let you choose a custom environment on your computer at first launch.

Build the application
```
yarn run clean && yarn build
```
Create JupyterLab Desktop Server installer
```
yarn create_env_installer:<platform>
```
Create JupyterLab Desktop installer which will also bundle JupyterLab Desktop Server installer.
```
yarn dist:<platform>
```
Application Installer will be created in dist/JupyterLab.dmg (macOS), dist/JupyterLab.deb (Debian, Ubuntu), dist/JupyterLab.rpm (Red Hat, Fedora) and dist/JupyterLab-Setup.exe (Windows) based on the platform

For instructions on updating bundled JupyterLab packages and cutting a new release, please follow Release.md document.