Skip to content

Commit 720747a

Browse files
Merge pull request #29 from jtpio/dev-docs
Add instructions for local development
2 parents d357a28 + e268e69 commit 720747a

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,31 @@ the vertical space available. If more content is displayed, the natural height
3535
is used instead.
3636

3737
![sidecar](sidecar.gif)
38+
39+
## Development
40+
41+
```bash
42+
# Create a new conda environment
43+
conda create -n jupyterlab-sidecar -c conda-forge jupyterlab ipywidgets nodejs
44+
45+
# Activate the conda environment
46+
conda activate jupyterlab-sidecar
47+
48+
# Install dependencies
49+
jlpm
50+
51+
# Build Typescript source
52+
jlpm build
53+
54+
# Link your development version of the extension with JupyterLab
55+
jupyter labextension link .
56+
57+
# Rebuild Typescript source after making changes
58+
jlpm build
59+
60+
# Rebuild JupyterLab after making any changes
61+
jupyter lab build
62+
63+
# Install the sidecar Python package
64+
python -m pip install -e .
65+
```

0 commit comments

Comments
 (0)