You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-43Lines changed: 17 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ for a friendly and welcoming collaborative environment.
10
10
Note: You will need NodeJS to build the extension package.
11
11
12
12
The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
13
-
`yarn` or `npm` mentioned as an alternative, in lieu of `jlpm` below.
13
+
`yarn` or `npm`, in lieu of `jlpm` below.
14
14
15
15
**Note**: we recommend using `mamba` to speed the creating of the environment.
16
16
@@ -30,9 +30,24 @@ jlpm develop
30
30
# Enable the server extension
31
31
jupyter server extension enable notebook
32
32
```
33
+
### Set Up a Python Virtual Environment:
34
+
As the Jupyter Notebook includes a Jupyter Server extension written in Python, it's recommended to create a virtual environment. You can use the `venv` module for this:
35
+
```bash
36
+
python -m venv venv
37
+
source venv/bin/activate # On Windows, use: venv\Scripts\activate
38
+
```
39
+
After setting up the environment (either with mamba or venv), you'll need to handle the JavaScript dependencies:
33
40
41
+
Install NodeJS Dependencies:
42
+
If you're using `yarn`:
43
+
```bash
44
+
yarn install
45
+
```
46
+
If you're using `npm`:
47
+
```bash
48
+
npm install
49
+
```
34
50
`notebook` follows a monorepo structure. To build all the packages at once:
### Alternative : Using "yarn" and "npm" over "mamba"
69
-
70
-
If you prefer using `yarn` or `npm` over `mamba`, you can follow these steps to set up your development environment:
71
-
72
-
Clone the Repository:
73
-
```bash
74
-
git clone https://github.com/jupyter/notebook.git
75
-
cd notebook
76
-
```
77
-
78
-
Install NodeJS Dependencies:
79
-
If you're using `yarn`:
80
-
```bash
81
-
yarn install
82
-
```
83
-
If you're using `npm`:
84
-
```bash
85
-
npm install
86
-
```
87
-
### Set Up a Python Virtual Environment:
88
-
As the Jupyter Notebook includes a Jupyter Server extension written in Python, it's recommended to create a virtual environment. You can use the `venv` module for this:
89
-
```bash
90
-
python -m venv venv
91
-
source venv/bin/activate # On Windows, use: venv\Scripts\activate
0 commit comments