Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Contributing Guide for Developer Installation #81

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Update Contributing Guide for Developer Installation #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84819f4
Update Contributing Guide
arjxn-py Jul 30, 2024
68fa7cc
Remove docker as requirement in doc.
brichet Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,21 @@

### Development install

Note: You will need NodeJS to build the extension package.
**Note:** You will need [Node.js](https://nodejs.org/) to build the extension package.

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
git clone https://github.com/QuantStack/jupytergis.git
# Change directory to the jupytergis directory
cd jupytergis
# Install JupyterLab for jlpm
pip install jupyterlab
# Install package in development mode
pip install -e .
python scripts/dev-install.py
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
Expand Down
Loading