Skip to content

Commit 381f08a

Browse files
authored
Move development installation to contribution guide (#48)
1 parent 8feb5c7 commit 381f08a

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,37 @@ that we believe are good examples of small, self-contained changes. We
1212
encourage those that are new to the code base to implement and/or ask
1313
questions about these issues.
1414

15+
## Development installation
16+
17+
You will need to install `yarn` (for example with `npm install --global yarn`).
18+
19+
To build the components packages, execute:
20+
21+
```sh
22+
yarn install
23+
yarn build
24+
```
25+
26+
Then to interactively test or develop web components:
27+
28+
```sh
29+
cd packages/components
30+
yarn start
31+
```
32+
33+
### JupyterLab demo extension
34+
35+
To test locally the JupyterLab demo extension, using `conda` package manager:
36+
37+
```sh
38+
conda create -n jupyter-toolkit -c conda-forge -y nodejs yarn jupyterlab=3
39+
conda activate jupyter-toolkit
40+
yarn install
41+
yarn build
42+
pip install -e .
43+
jupyter labextension develop --overwrite .
44+
```
45+
1546
## General Guidelines for Contributing
1647

1748
For general documentation about contributing to Jupyter projects, see

README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -84,37 +84,6 @@ A pre-bundled script that contains all APIs needed to use Jupyter UI Toolkit is
8484

8585
The above CDN location points to the latest release of `@jupyter-notebook/web-components`. It is advised that when you deploy your site or app, you import the specific version you have developed and tested with.
8686

87-
## Contributing
88-
89-
You will need to install `yarn` (for example with `npm install --global yarn`).
90-
91-
To build the components packages, execute:
92-
93-
```sh
94-
yarn install
95-
yarn build
96-
```
97-
98-
Then to interactively test or develop web components:
99-
100-
```sh
101-
cd packages/components
102-
yarn start
103-
```
104-
105-
### JupyterLab demo extension
106-
107-
To test locally the JupyterLab demo extension, using `conda` package manager:
108-
109-
```sh
110-
conda create -n jupyter-toolkit -c conda-forge -y nodejs yarn jupyterlab=3
111-
conda activate jupyter-toolkit
112-
yarn install
113-
yarn build
114-
pip install -e .
115-
jupyter labextension develop --overwrite .
116-
```
117-
11887
## Documentation
11988

12089
Further documentation can be found in the following places:

0 commit comments

Comments
 (0)