Setup with a Conda environment

Follow the below steps to use and develop Jupyter UI.

You need Miniconda up-and-running on your machine.

macOS or Linux are supported out-of-the-box.

If you run on Windows, Cygwin is needed and your will need to run the commands from a Cygwin shell.

Only yarn is supported - npm or pnpm will not work.

This is due to some dependency on the JupyterLab build system which only supports yarn.

Clone the jupyter-ui repository.

git clone https://github.com/datalayer/jupyter-ui.git && \
  cd jupyter-ui

If you already have created a conda environment named datalayer, please remove it.

conda deactivate
conda remove -y --all -n datalayer

Create a new conda environment and activate it.

conda env create -f environment.yml
conda activate datalayer