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.

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

Setting up a Development environment using yarn and npm #1

Merged
merged 1 commit into from
Oct 9, 2023
Merged
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ for a friendly and welcoming collaborative environment.
Note: You will need NodeJS 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.
`yarn` or `npm` mentioned as an alternative, in lieu of `jlpm` below.

**Note**: we recommend using `mamba` to speed the creating of the environment.

Expand Down Expand Up @@ -62,6 +62,47 @@ Config dir: /usr/local/etc/jupyter

Then start Jupyter Notebook with:

```bash
jupyter notebook
```
### Alternative : Using "yarn" and "npm" over "mamba"

If you prefer using `yarn` or `npm` over `mamba`, you can follow these steps to set up your development environment:

Clone the Repository:
```bash
git clone https://github.com/jupyter/notebook.git
cd notebook
```

Install NodeJS Dependencies:
If you're using `yarn`:
```bash
yarn install
```
If you're using `npm`:
```bash
npm install
```
### Set Up a Python Virtual Environment:
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:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use: venv\Scripts\activate
```
Install Python Dependencies:
```bash
pip install -e ".[dev,test]"
```
Build the Notebook:
```bash
jlpm build
```
Enable the Server Extension:
```bash
jupyter server extension enable notebook
```
Start Jupyter Notebook:
```bash
jupyter notebook
```
Expand Down